Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Данный справочник содержит информацию об организациях (Id,Name, Level, org_managing_id, org_managing_name).

...

org_managing_name - String (Имя УО)

OutLinkId - String (Внешний ID)

...

Получение данных по одной организации

Чтобы получить список всех организаций, нужно отправить GET запрос на адрес  https://teletrack.ua/api/v2/<token>/organs/<Id>, где

tokenТокен
получен
, полученный при авторизации *
Id
ID организации в БД *

 * - обязательный параметр


В случае успешного выполнения запроса, приходит ответ со списком организаций следующего формата:

Code Block
themeEclipse
{

...


"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Токен, полученный при авторизации *

 * - обязательный параметр


В случае успешного выполнения запроса, приходит ответ со списком организаций следующего формата:

Code Block
themeEclipse
{
 "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

 * - обязательный параметр


В случае успешного выполнения запроса, приходит ответ следующего вида:

Code Block
themeEclipse
{
  "data": {
    "Id": 149
  }, 
  "err": null, 
  "status": true
}


IdID новой записи в БД

Редактирование записи

...

Для редактирования существующей записи, необходимо отправить  PUT запрос на адрес https://teletrack.ua/api/v2/<token>/organs/<Id><Id>, где

IdID записи в БД *
NameИзмененное имя *
OrganizationIdИзмененный Опционально ели єто УО ID новой управляющей организации. Опционально если это УО, то передавать не нужно, если нет то ИД ID УО
tokenТокен получен при авторизации, полученный при авторизации *
OutLinkIdВнешний ID
DeleteMarked
Пометка удаления: true / false

 * - обязательный параметр


В случае успешного выполнения запроса, приходит ответ следующего вида:

Code Block
themeEclipse
{
  "data": null, 
  "err": null, 
  "status": true
}

Удаление записи .

Для удаления существующей записи, необходимо отправить  DELETE запрос на адрес httpss://teletrack.ua/api/v2/<token>/organs/<Id>, где

IdID записи в БД которою нужно удалить *
tokenТокен получен , полученный при авторизации *

 * - обязательный параметр


В случае успешного выполнения запроса, приходит ответ следующего вида:

Code Block
themeEclipse
{
  "data": null, 
  "err": null, 
  "status": true
}