Rest API Список документов инвентаризации

29. Ресурс `/stock-taking-documents/` (Документ инвентаризации, Коллекция, только для чтения)

Документ инвентаризации. С помощью ресурса /stock-taking-documents/ можно получить доступ к списку документов инвентаризации. А также добавлять в справочник новые документы.

29.1. Структура объекта Stock Taking documents:

Название поля	Тип поля	Размер	Обязательное	Только чтение	Примечание
`url`	URL		нет	да	url этого объекта
`document_id`	строка		да	нет	идентификатор документа
`date`	дата, время	50	да	нет	дата и время инвентаризации
`shop_id`	строка	50	да	нет	идентификатор магазина
`shop_url`	URL		нет	да	url этого объекта
`stuff_id`	строка	50	нет	нет	идентификатор кассира
`stuff_url`	строка		нет	да	url этого кассира
`products`	список		да	нет	массив товаров

29.1.2. Структура объекта ТОВАРЫ (`PRODUCTS`):

Каждый товар содержит в себе некие характеристики, которые можно представить в следующей структуре:

Название поля	Тип поля	Размер	Обязательное	Только чтение	Примечание
`product_id`	строка	200	да	нет	идентификатор товара со Справочника по товарам (див.[`/products/`])
`product_url`	URL		нет	да	url товара
`stock_qty`	число		да	да	количество товара на остатке
`fact_qty`	число		да	да	фактическое количество товаров на остатке

29.2. Доступные команды

Для управления ресурсом /stock-taking-documents/ поддерживаются следующие команды:

GET - получить одну страницу коллекции
POST - загрузить документы
OPTIONS - мета-информация по структуре объекта
HEAD - аналог GET, но возвращается только заголовок ответа

29.2.1. `GET /stock-taking-documents/` - получить одну страницу коллекции.

Вид команды: GET http://api.datawiz.io/api/v1/stock-taking-documents

Суффиксы:

.json - получить ответ с сервера в формате JSON
.api - получить ответ с сервера в формате HTML (тестовая платформа)

Параметры:

format = json | api - аналог вышеуказанных суффиксов
page_size = nn - установить размер страницы равен nn объектов
page = n - загрузить страницу n
search = text - отображать только объекты, в поле name где найдено "text"
ordering = name | identifier - сортировать по полю в алфавитном порядке (от меньшего - к большему)
ordering = -name | -identifier - сортировать по полю в обратном порядке

Ответ сервера:

Объект "коллекция" состоит из четырех полей (count, next, previous, results).

Пример пустой коллекции, полученной в результате запроса:

GET http://api.datawiz.io/api/v1/stock-taking-documents/.json/?search=unknown-string

{
     "count": 0,
     "next": null,
     "previous": null,
     "results": [] 
}

Пример коллекции: GET http://api.datawiz.io/api/v1/stock-taking-documents/?format=api&page_size=2:

HTTP 200 OK
Content-Type: application/json
Vary: Accept
Allow: GET, HEAD, OPTIONS
[
       {
            "url": "http://api.datawiz.io/api/v1/stock-taking-documents/cb2084aa-4644-11e5-80d8-a01d4897e530/",
            "document_id": "cb2084aa-4644-11e5-80d8-a01d4897e530",
            "date": "2015-01-01T00:00:00",
            "shop_id": "675",
            "shop_url": "http://api.datawiz.io/api/v1/shops/46e08f10-cbe3-11e4-80b9-a01d4897e530/",
            "stuff_id": null,
            "stuff_url": null,
            "products": [
                {
                    "product_id": null,
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e530/",
                    "stock_qty": "2.0000",
                    "fact_qty": "10.0000"
                }
            ]
        },
        . . .
    ]
}

Сообщение об ошибке:

В случае ошибки сервер возвращает ответ с соответствующим статусом, а также сообщением об ошибке, записанным в ключе detail и / или в поле http.response.content:

HTTP 404 NOT FOUND 
Content-Type: application/json 
Vary: Accept 
Allow: GET, HEAD, OPTIONS, PATCH 
{
"detail": "Not found"
}

29.2.2 `POST /stock-taking-documents/` - добавить информацию по документу.

Вид команды: POST http://api.datawiz.io/api/v1/stock-taking-documents/?format=json

Суффиксы:

.json - получить ответ с сервера в формате JSON
.api - получить ответ с сервера в формате HTML (тестовая платформа)

Параметры:

format = json | api - аналог вышеуказанных суффиксов

Данные запроса:

В запросе передается JSON-объект типа словарь (dictionary), который описывает документ. Важные поля: document_id, shop_id, document_date, product_id, stock_qty, fact_qty. Последовательность полей не принципиальна.

Пример запроса на загрузку документа на заказ продукта: POST http://api.datawiz.io/api/v1/stock-taking-documents/.json

{
            "url": "http://api.datawiz.io/api/v1/stock-taking-documents/cb2084aa-4644-11e5-80d8-a01d4897e530/",
            "document_id": "cb2084aa-4644-11e5-80d8-a01d4897e530",
            "date": "2015-01-01T00:00:00",
            "shop_id": "675",
            "shop_url": "http://api.datawiz.io/api/v1/shops/46e08f10-cbe3-11e4-80b9-a01d4897e530/",
            "stuff_id": null,
            "stuff_url": null,
            "products": [
                {
                    "product_id": null,
                    "product_url": "http://api.datawiz.io/api/v1/products/a26f866b-1465-11e5-80cb-a01d4897e530/",
                    "stock_qty": "2.0000",
                    "fact_qty": "10.0000"
                }
            ]
        }

Ответ сервера:

При корректной обработке запроса сервер возвращает код статуса 201 и статус создания объекта.

Пример ответа сервера:

HTTP 201 CREATED
Content-Type: application/json
Vary: Accept
Location: http://api.datawiz.io/api/v1/stock-taking-documents/124/
Allow: GET, POST, HEAD, OPTIONS
{
"updated": 0,
"inserted": 1
}

Условия и ограничения (Constraints):

Если объект с идентификатором document_id, shop_id уже существует на сервере, то указанный запрос заменит объект на сервере (replace) без предупреждения.
price_total должен быть равным price*qty.
Нельзя добавить на сервер объект, если не существует магазина с указанным идентификатором shop_id
Нельзя добавить на сервер объект, если не существует товара с указанным идентификатором product_id

Сообщение об ошибке:

В случае ошибки сервер возвращает ответ с соответствующим статусом, а также сообщением об ошибке, записанным напротив имени поля, с которым эта ошибка связана. Если ошибка касается не отдельного поля, а всего объекта, то сообщение об ошибке будет записано напротив ключа non_field_errors.

ПРИМЕЧАНИЕ. Каждое сообщение об ошибке представляет собой коллекцию (массив) строчных символов.

Пример ответа сервера при возникновении ошибки (поле qty передано пустым):

HTTP 400 BAD REQUEST 
Content-Type: application/json 
Vary: Accept 
Allow: GET, POST, HEAD, OPTIONS 
{
     "qty": [
         "This field is required." 
     ] 
}

29.2.3. `OPTIONS /stock-taking-documents/` - мета-информация по структуре объекта

При выполнении данной команды возвращается такая JSON-структура:

OPTIONS /api/v1/stock-taking-documents/

HTTP 200 OK
Content-Type: application/json 
Vary: Accept 
Allow: GET, POST, HEAD, OPTIONS 
{
    "name": "Stock Taking Document List",
    "description": "",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
            "url": {
                "type": "field",
                "required": false,
                "read_only": true,
                "label": "Url"
            },
            "document_id": {
                "type": "string",
                "required": true,
                "read_only": false,
                "label": "Document id",
                "max_length": 200
            },
            "stuff_id": {
                "type": "integer",
                "required": true,
                "read_only": false,
                "label": "Stuff id"
            },
            "stuff_url": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Stuff url"
            },
            "shop_id": {
                "type": "integer",
                "required": true,
                "read_only": false,
                "label": "Shop id"
            },
            "shop_url": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "Shop url"
            },
            "date": {
                "type": "datetime",
                "required": true,
                "read_only": false,
                "label": "Date"
            },
            "products": {
                "type": "field",
                "required": true,
                "read_only": false,
                "label": "Products",
                "child": {
                    "type": "nested object",
                    "required": true,
                    "read_only": false,
                    "children": {
                        "url": {
                            "type": "field",
                            "required": false,
                            "read_only": true,
                            "label": "Url"
                        },
                        "product_id": {
                            "type": "integer",
                            "required": true,
                            "read_only": false,
                            "label": "Product id"
                        },
                        "product_url": {
                            "type": "integer",
                            "required": false,
                            "read_only": true,
                            "label": "Product url"
                        },
                        "stock_qty": {
                            "type": "decimal",
                            "required": true,
                            "read_only": false,
                            "label": "Stock qty"
                        },
                        "fact_qty": {
                            "type": "decimal",
                            "required": true,
                            "read_only": false,
                            "label": "Fact qty"
                        }
                    }
                }
            }
        }
    }
}

Rest API Список документов инвентаризации - datawizio/pythonAPI GitHub Wiki

29. Ресурс `/stock-taking-documents/` (Документ инвентаризации, Коллекция, только для чтения)

29.1. Структура объекта Stock Taking documents:

29.1.2. Структура объекта ТОВАРЫ (`PRODUCTS`):

29.2. Доступные команды

29.2.1. `GET /stock-taking-documents/` - получить одну страницу коллекции.

Суффиксы:

Параметры:

Ответ сервера:

Сообщение об ошибке:

29.2.2 `POST /stock-taking-documents/` - добавить информацию по документу.

Суффиксы:

Параметры:

Данные запроса:

Ответ сервера:

Условия и ограничения (Constraints):

Сообщение об ошибке:

29.2.3. `OPTIONS /stock-taking-documents/` - мета-информация по структуре объекта

⚠️ GitHub.com Fallback ⚠️

Rest API Список документов инвентаризации - datawizio/pythonAPI GitHub Wiki

29. Ресурс /stock-taking-documents/ (Документ инвентаризации, Коллекция, только для чтения)

29.1. Структура объекта Stock Taking documents:

29.1.2. Структура объекта ТОВАРЫ (PRODUCTS):

29.2. Доступные команды

29.2.1. GET /stock-taking-documents/ - получить одну страницу коллекции.

Суффиксы:

Параметры:

Ответ сервера:

Сообщение об ошибке:

29.2.2 POST /stock-taking-documents/ - добавить информацию по документу.

Суффиксы:

Параметры:

Данные запроса:

Ответ сервера:

Условия и ограничения (Constraints):

Сообщение об ошибке:

29.2.3. OPTIONS /stock-taking-documents/ - мета-информация по структуре объекта

⚠️ **GitHub.com Fallback** ⚠️

29. Ресурс `/stock-taking-documents/` (Документ инвентаризации, Коллекция, только для чтения)

29.1.2. Структура объекта ТОВАРЫ (`PRODUCTS`):

29.2.1. `GET /stock-taking-documents/` - получить одну страницу коллекции.

29.2.2 `POST /stock-taking-documents/` - добавить информацию по документу.

29.2.3. `OPTIONS /stock-taking-documents/` - мета-информация по структуре объекта

⚠️ GitHub.com Fallback ⚠️