Департаменты API
Данный справочник содержит информацию о подразделения (Id, Name, OrganizationId, orgname).
Id - INT (идентификатор записи)
Name - String (имя департамента)
OrganizationId - INT (идентификатор организации)
orgname - String (имя организации)
OutLinkId - String (Внешний ID)
Получение данных по одному департаменту
Чтобы получить информацию по одному департамкнту, нужно отправить GET запрос на адрес https://teletrack.ua/api/v2/<token>/departs/<Id>, где
token | Токен, полученный при авторизации * |
Id | Id департамента из БД * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего формата:
{ "data": [ { "Id": 7, "Name": "DepSOROKA", "OrganizationId": 5, "OutLinkId": "ghe5rtgdd", "Parent": "53a294672eb21fb66500e57e", "Parent_type": "diler", "orgname": "Org33" }], "err": null, "status": true }
Получение списка департаментов
Чтобы получить список всех департаментов, нужно отправить GET запрос на адрес https://teletrack.ua/api/v2/<token>/departs/, где
token | Токен, полученный при авторизации * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ со списком департаментов следующего формата:
{ "data": [ { "Id": 1, "Name": "Dep1", "OrganizationId": 5, "OutLinkId": 65987, "Parent": "53a294672eb21fb66500e57e", "Parent_type": "diler", "orgname": "Org33" }, { "Id": 7, "Name": "DepSOROKA", "OrganizationId": 5, "OutLinkId": null, "Parent": "53a294672eb21fb66500e57e", "Parent_type": "diler", "orgname": "Org33" } ], "err": null, "status": true }
Создание новой записи
Для создания новой записи, необходимо отправить POST запрос на адрес https://teletrack.ua/api/v2/<token>/departs/, где
Name | Имя нового департамента * |
OrganizationId | Id организации, к которой принадлежит департамент * |
token | Токен, полученный при авторизации * |
OutLinkId | Внешний ID |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{ "data": { "Id": 149 }, "err": null, "status": true }
Id | ID новой |
Редактирование записи
Для редактирования существующей записи, необходимо отправить PUT запрос на адрес https://teletrack.ua/api/v2/<token>/departs/<Id>, где
Id | ID |
Name | Измененное имя * |
OrganizationId | ИД организации к которой пренадлежит департамент * |
token | Токен, полученный при авторизации * |
OutLinkId | Внешний ID |
DeleteMarked | Пометка удаления: true / false |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{ "data": null, "err": null, "status": true }
Удаление записи
Для удаления существующей записи, необходимо отправить DELETE запрос на адрес https://teletrack.ua/api/v2/<token>/departs/<Id>, где
Id | ID |
token | Токен, полученный при авторизации * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{ "data": null, "err": null, "status": true }