Appearance
/agent
Кінцева точка /agent відповідає за роботу з контрагентами.
GET /agent/load/{uid}
Завантажує контрагента по його UID.
Параметри запиту:
- uid - UID контрагента (в URL)
Повертає стандартну відповідь з об'єктом Agent.
javascript
{
"success" : true,
"data": { /* Agent */
"uid": "...."
}
};{
"success" : true,
"data": { /* Agent */
"uid": "...."
}
};GET /agent/index/?{pageSize=20}&{offset=0}
Завантажує перелік контрагентів.
Параметри запиту:
- pageSize - розмір сторінки (1-20).
- offset - зміщення ( > 0)
Повертає стандартну відповідь для індексу об'єктів Agent.
javascript
{
"success" : true,
"totalCount": 10,
"data": { /* Agent */
"uid": "...."
}
};{
"success" : true,
"totalCount": 10,
"data": { /* Agent */
"uid": "...."
}
};Зверніть увагу, що поле totalCount поверне загальну кількість контрагентів в системі.
GET /agent/find/?{what=what}&{value=value}
Виконує пошук контрагента по значенню. Буде повернуто тільки 10 перших знайдених контрагентів.
Параметри запиту:
- what - по чому шукати. Можливі значення:
- code - пошук по коду ЄДРПОУ/ІПН (повне співпадіння).
- value - значення для пошуку.
Повертає стандартну відповідь масива об'єктів Agent.
javascript
{
"success" : true,
"count": 10,
"data": { /* Agent */
"uid": "...."
}
};{
"success" : true,
"count": 10,
"data": { /* Agent */
"uid": "...."
}
};Зверніть увагу, що поле count поверне кількість знайдених контрагентів.
POST /agent/update
Створює або оновлює властивості контрагента.
Тіло запита має бути обєктом Agent:
javascript
{
"uid" : "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Компанія",
"type": "company"
}{
"uid" : "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Компанія",
"type": "company"
}Якщо поле "type" не вказано - будет застосовано значення "company".
Повертає стандартну відповідь з об'єктом Agent.
javascript
{
"success" : true,
"data": { /* Agent */
"uid": "...."
}
}{
"success" : true,
"data": { /* Agent */
"uid": "...."
}
}POST /agent/batch
Створює або оновлює властивості контрагентів пакетом.
Тіло запита має бути масивом обєктів Agent
javascript
[
{
"uid" : "d50bce46-2867-44ce-b264-4daac69701c5",
"name": "Компанія №1",
"type": "company"
},
{
"uid" : "5845b880-da52-4fa5-98d9-ea6775307c32",
"name": "Компанія №2",
"type": "company"
}
][
{
"uid" : "d50bce46-2867-44ce-b264-4daac69701c5",
"name": "Компанія №1",
"type": "company"
},
{
"uid" : "5845b880-da52-4fa5-98d9-ea6775307c32",
"name": "Компанія №2",
"type": "company"
}
]Повертає стандартну відповідь з об'єктом BatchResult.
javascript
{
"success" : true,
"data": {
"count": 5
}
}{
"success" : true,
"data": {
"count": 5
}
}GET /agent/contract/index/{uid}
Завантажує договори для контрагента.
Параметри запиту:
- uid - UID контрагента (в URL)
Повертає стандартну відповідь для індексу об'єктів Contract.
javascript
{
"success" : true,
"totalCount": 10,
"data": { /* Contract */
"uid": "...."
}
};{
"success" : true,
"totalCount": 10,
"data": { /* Contract */
"uid": "...."
}
};