Данный справочник содержит информацию об организациях (Id,Name, Level, org_managing_id, org_managing_name).
Существует понятие управляющей организации (УО) (находится в той же таблице, что и организации, но имеет признак Level = 2)
Id - INT (идентификатор записи)
Level - INT (идентификатор статуса 1 - организация; 2 - УО)
org_managing_id - INT (идентификатор записи УО)
Name - String (Имя организации)
org_managing_name - String (Имя УО)
OutLinkId - String (Внешний ID)
Получение данных по одной организации
Чтобы получить список всех организаций, нужно отправить GET запрос на адрес https://teletrack.ua/api/v2/<token>/organs/<Id>, где
token | Токен, полученный при авторизации * |
Id | ID организации в БД * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ со списком организаций следующего формата:
{
"data": [
{
"Id": 43,
"Level": 1,
"Name": "trest",
"OutLinkId": "111",
"Parent": "53a294672eb21fb66500e57e",
"Parent_type": "diler",
"org_managing_id": 18,
"org_managing_name": "MainOrg3"
}
],
"err": null,
"status": true
}
Получение списка организаций
Чтобы получить список всех организаций, нужно отправить GET запрос на адрес https://teletrack.ua/api/v2/<token>/organs/, где
token | Токен, полученный при авторизации * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ со списком организаций следующего формата:
{
"data": [
{
"Id": 15,
"Level": 2,
"Name": "MainOrg1UP",
"OutLinkId": null,
"Parent": "53a294672eb21fb66500e57e",
"Parent_type": "diler",
"org_managing_id": null,
"org_managing_name": null
},
{
"Id": 21,
"Level": 1,
"Name": "SubOrg3",
"OutLinkId": "2222",
"Parent": "53a294672eb21fb66500e57e",
"Parent_type": "diler",
"org_managing_id": 20,
"org_managing_name": "MainOrg4"
},
{
"Id": 43,
"Level": 1,
"Name": "trest",
"OutLinkId": "001",
"Parent": "53a294672eb21fb66500e57e",
"Parent_type": "diler",
"org_managing_id": 18,
"org_managing_name": "MainOrg3"
}
],
"err": null,
"status": true
}
Создание новой записи
Для создания новой записи , необходимо отправить POST запрос на адрес https://teletrack.ua/api/v2/<token>/organs/, где
token | Токен, полученный при авторизации * |
Name | Имя новой организации * |
Level | Идентификатор статуса 1 - организация 2 - УО * |
OrganizationId | ID управляющей организации. Опционально если это УО, то передавать не нужно, если нет то ID УО * |
OutLinkId | Внешний ID |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{
"data": {
"Id": 149
},
"err": null,
"status": true
}
Id | ID новой |
Редактирование записи
Для редактирования существующей записи, необходимо отправить PUT запрос на адрес https://teletrack.ua/api/v2/<token>/organs/<Id>, где
Id | ID |
Name | Измененное имя * |
OrganizationId | ID новой управляющей организации. Опционально если это УО, то передавать не нужно, если нет то ID УО |
token | Токен, полученный при авторизации * |
OutLinkId | Внешний ID |
DeleteMarked | Пометка удаления: true / false |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{
"data": null,
"err": null,
"status": true
}
Удаление записи .
Для удаления существующей записи, необходимо отправить DELETE запрос на адрес httpss://teletrack.ua/api/v2/<token>/organs/<Id>, где
Id | ID |
token | Токен, полученный при авторизации * |
* - обязательный параметр
В случае успешного выполнения запроса, приходит ответ следующего вида:
{
"data": null,
"err": null,
"status": true
}