Группы геозон
- Oleksii Potapenko
Получение списка групп геозон
Для получения списка групп геозон, необходимо отправить GET запрос:
https://teletrack.ua/api/v2/<token>/zones/groups/
где:
token | Токен полученный при авторизации |
|---|
В случае успешного выполнения запроса, должен прийти ответ со списком групп следующего формата:
{
"data": [
{
"Department": {
"Id": 1929,
"Name": "Тестовый"
},
"Id": 1157,
"Name": "Тест098_0123",
"Organization": {
"Id": 1323,
"Name": "OP_Tester"
},
"OutLinkId": ""
}
],
"err": null,
"status": true
}
Где блоки содержат следующую информацию:
Информация о департаменте который присвоен группе геозон | |
Department | Наименование блока данных |
Id | Внутренний идентификатор департамента, в таблице данных “Департамент” |
Name | Название департамента |
Группа геозон | |
Id | Внутренний идентификатор группы геозон, в таблице данных “Группы геозон”. Для выполнения запросов редактирования/удаления необходимо использовать именно его. |
Name | Название группы геозон |
Организация, которой принадлежит группа геозон | |
Organization | Наименование блока данных |
Id | Внутренний идентификатор организации, в таблице данных “Организации” |
Name | Название организации |
Дополнительный блок OutLinkId группы геозон | |
OutLinkId | Внешний идентификатор присваеваемый группе геозон, для интеграции с сторонними приложениями |
Создание групы геозон
Для создания группы геозон, необходимо отправить POST запрос на адрес
https://teletrack.ua/api/v2/<token>/zones/groups/
где:
token | Токен полученный при авторизации |
|---|
в формате JSON, с параметрами:
{
"DepartId":"____",
"Name":"________",
"OutLinkId":"____________"
}
где:
DepartId | Внутренний идентификатор департамента, в таблице данных “Департамент” |
Name | Название новой группы геозон |
OutLinkId | Внешний идентификатор присваеваемый группе геозон, для интеграции с сторонними приложениями |
В случае успешного выполнения запроса, приходит ответ следующего формата:
{
"data": {
"Id": 1162
},
"err": null,
"status": true
}где:
Id | Внутренний идентификатор созданной группы геозон, в таблице данных “Группы геозон”. Для выполнения запросов редактирования/удаления необходимо использовать именно его. |
Редактирование группы геозон
Для редактирования группы геозон, необходимо отправить PUT запрос на адрес:
https://teletrack.ua/api/v2/<token>/zones/groups/<ID>
где:
token | Токен полученный при авторизации |
ID | Внутренний идентификатор редактируемой группы геозон, в таблице данных “Группы геозон”. |
в формате JSON, с параметрами которые необходимо отредактировать (в запросе должны быть только те параметры, которые редактируются):
где
DepartId | Внутренний идентификатор департамента который нужно присвоить(заменить) группе геозон, в таблице данных “Департамент” |
Name | Новое название группы геозон |
OutLinkId | Новый внешний идентификатор присваеваемый группе геозон, для интеграции с сторонними приложениями |
В случае успешного выполнения запроса, приходит ответ следующего формата:
Удаление группы геозон
Для удаления группы геозон, необходимо отправить DELETE запрос на адрес:
https://teletrack.ua/api/v2/<token>/zones/groups/<ID>
где:
token | Токен полученный при авторизации |
ID | Внутренний идентификатор редактируемой группы геозон, в таблице данных “Группы геозон”. |
В случае успешного выполнения запроса, приходит ответ следующего формата: