Introduction

Bu doküman honoplay-api-helper-node'un nasıl kullanılacağını açıklar.

Get Started

$3

"axios" : Promise tabanlı olarak yayınlanmış, tarayıcı ve node.js tarafında çalışabilir bir HTTP client.

> npm install axios

> yarn add axios

"axios-retry" : Başarısız istekleri engelleyen ve mümkün olduğunda bunları yeniden deneyen Axios eklentisi.

> npm install axios-retry

> yarn add axios-rety

$3

> npm i @omegabigdata/honoplay-api-helper-node

> yarn add @omegabigdata/honoplay-api-helper-node

Components

Admin User

Admin User componenti register, authenticate ve renew token işlemlerini kapsar.

$3

Kullanıcının register işleminin gerçekleşmesini sağlar.

``http
POST /api/AdminUser/register
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| registerModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> registerModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| email | string | Required. |
| password | string | Required. |
| name | string | Required. |
| surname | string | Required. |

$3

Kullanıcının bilgilerinin doğrulandığı ve token işleminin gerçekleştirildiği kısımdır.

`http
GET /api/AdminUser/authenticate
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| getAuthenticateModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> getAuthenticateModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| email | string | Required. |
| password | string | Required. |

$3

Token yenileme işleminin gerçekleşmesini sağlar.

`http
POST /api/AdminUser/renew-token
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| token | string | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

Status

Status componenti hangi ortamda çalıştığımızı öğrenebileceğimiz fonksiyonu kapsar.

$3

`http
GET /api/Status
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

Tenant

Tenant componenti Tenant ekleme, Tenant güncelleme, Tenant listeleme ve id'ye göre Tenant bilgileri listeleme fonksiyonlarını kapsar.

$3

Sisteme Tenant ekleme işlemini gerçekleştirir.

`http
POST /api/Tenant
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| tenantModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> tenantModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| name | string | Required. |
| description | string | Required. |
| hostName | string | Required. |
| logo | string | Required. |




$3

Sistemde kayıtlı olan Tenant bilgilerinin güncellenmesini sağlar.

`http
PUT /api/Tenant
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| tenantModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> tenantModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| id | int | Required. Tenant id|
| name | string | Required. |
| description | string | Required. |
| hostName | string | Required. |
| logo | string | Required. |

$3

Sistemde kayıtlı olan Tenant'ların görüntülenmesini sağlar.

`http
GET /api/Tenant
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| skip | int | Required. Kaç items atlansın|
| take | int | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

$3

Sistemde kayıtlı olan istenilen Tenant bilgilerinin görüntülenmesini sağlar.

`http
GET /api/Tenant/{id}
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| tenantId | int | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|


> departmentModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| tenantId | int | Required. |
| departments | object | Required. departmen name |

Traniee

Tenant componenti Trainee ekleme, Trainee güncelleme, Trainee listeleme ve id'ye göre Trainee bilgilerini listeleme fonksiyonlarını kapsar.

$3

Sisteme Traniee ekleme işlemini gerçekleştirir.

`http
POST /api/Traniee
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| traineeModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> traineeModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| name | string | Required. |
| surname | string | Required. |
| nationalIdentitynumber | int | Required. |
| phonenumber | string | Required. |
| gender | int | Required. |
| workingStatusId | string | Required. |
| departmentId | string | Required. |

$3

Sistemde kayıtlı olan Trainee bilgilerinin güncellenmesini sağlar.

`http
PUT /api/Traniee
`

| Parameter | Type | Description |
| :--- | :--- | :--- |
| traineeModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

> traineeModel

| Parameter | Type | Description |
| :--- | :--- | :--- |
| id | int | Required. Traniee id|
| name | string | Required. |
| surname | string | Required. |
| nationalIdentitynumber | int | Required. |
| phonenumber | string | Required. |
| gender | int | Required. |
| workingStatusId | string | Required. |
| departmentId | string | Required. |

$3

Sistemde kayıtlı olan Trainee'lerin görüntülenmesini sağlar.

`http
GET /api/Traniee
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| skip | int | Required. Kaç items atlansın|
| take | int | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|




$3

Sistemde kayıtlı olan istenilen Trainee bilgilerinin görüntülenmesini sağlar.

`http
GET /api/Traniee/{id}
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| traineeId | int | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

Department

Department componenti Departman ekleme ve Departmanları listeleme fonksiyonlarını kapsar.

$3

Sistemde kayıtlı olan Departmanların görüntülenmesini sağlar.

`http
GET /api/Department
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| skip | int | Required. Kaç items atlansın|
| take | int | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|

$3

Sisteme Departman ekleme işleminin gerçekleştirilmesini sağlar.

`http
POST /api/Department
`
| Parameter | Type | Description |
| :--- | :--- | :--- |
| departmentModel | object | Required. |
| successCallback | function | Required. İşlem başarılı bir şekilde sonuçlandığında successCallback çalışır. |
| errorCallback | function | Required. İşlem bir hata ile sonuçlandığında Invalid Parameters mesajı gösterilir.|




Responses

Geçersiz bir istek gönderilirse veya başka bir hata oluşursa, aşağıdaki durum kodlarını döndürür:

$3


| Status Code | Description |
| :--- | :--- |
| 200 | SUCCESS |
| 201 | CREATED |
| 400 | BAD REQUEST |
| 404 | NOT FOUND |
| 409 | CONFLICT |
| 500 | INTERNAL SERVER ERROR` |