Appearance
/entity
Кінцева точка /entity відповідає за роботу з об'єктами обліку.
GET /entity/load/{uid}
Завантажує об'єкт обліку по його UID.
Параметри запиту:
- uid - UID об'єктf обліку (в URL)
Повертає стандартну відповідь з об'єктом entity.
javascript
{
"success" : true,
"data": { /* entity */
"uid": "...."
}
};{
"success" : true,
"data": { /* entity */
"uid": "...."
}
};GET /entity/index/?{pageSize=20}&{offset=0}
Завантажує перелік об'єктів обліку.
Параметри запиту:
- pageSize - розмір сторінки (1-20).
- offset - зміщення ( > 0)
Повертає стандартну відповідь для індексу об'єктів entity.
javascript
{
"success" : true,
"totalCount": 10,
"data": { /* entity */
"uid": "...."
}
};{
"success" : true,
"totalCount": 10,
"data": { /* entity */
"uid": "...."
}
};Зверніть увагу, що поле totalCount поверне загальну кількість об'єктів обліку в системі.
GET /entity/find/?{what=what}&{value=value}
Виконує пошук об'єктів обліку по значенну. Буде повернуто тільки 10 перших знайдених об'єктів обліку.
Параметри запиту:
- what - по чому шукати. Можливі значення:
- article - пошук по артикулу (повне співпадіння).
- barcode - пошук по баркоду (повне співпадіння).
- value - значення для пошуку.
Повертає стандартну відповідь масива об'єктів entity.
javascript
{
"success" : true,
"count": 10,
"data": { /* entity */
"uid": "...."
}
};{
"success" : true,
"count": 10,
"data": { /* entity */
"uid": "...."
}
};Зверніть увагу, що поле count поверне кількість знайдених об'єктів обліку.
POST /entity/update
Створює або оновлює властивості об'єкта обліку.
Тіло запита має бути обєктом entity:
javascript
{
"uid" : "5f2310e9-46c6-42af-af92-0eb03eded28c",
"name": "Продукція №1",
"kind": "product"
}{
"uid" : "5f2310e9-46c6-42af-af92-0eb03eded28c",
"name": "Продукція №1",
"kind": "product"
}Якщо поле "kind" не вказано - будет застосовано значення "goods".
Повертає стандартну відповідь з об'єктом entity.
javascript
{
"success" : true,
"data": { /* entity */
"uid": "...."
}
}{
"success" : true,
"data": { /* entity */
"uid": "...."
}
}POST /entity/batch
Створює або оновлює властивості об'єктів обліку пакетом.
Тіло запита має бути масивом обєктів entity
javascript
[
{
"uid" : "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Товар № 1",
"kind": "goods"
},
{
"uid" : "29f6f25f-fa78-4746-9c7e-000f11435cd4",
"name": "Послуга № 2",
"kind": "service"
}
][
{
"uid" : "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Товар № 1",
"kind": "goods"
},
{
"uid" : "29f6f25f-fa78-4746-9c7e-000f11435cd4",
"name": "Послуга № 2",
"kind": "service"
}
]Повертає стандартну відповідь з об'єктом BatchResult.
javascript
{
"success" : true,
"data": {
"count": 5
}
}{
"success" : true,
"data": {
"count": 5
}
}