Получить список каталогов категорий |
Список параметров:
Параметры | Тип | Описание | Обязательный | Формат |
---|---|---|---|---|
first_ts | date | Отобразить каталоги измененные после заданного значения | нет | YYYY-MM-DD |
last_ts | date | Отобразить каталоги измененные до заданного значения | нет | YYYY-MM-DD |
Пример запроса
curl -XGET "[endpoint]/catalogs/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
{ "count": 1, "next": null, "previous": null, "results": [ { "id": 3, "name": "Master Каталог", "code": "master", "created": "2017-12-04T19:45:31.975140", "modified": "2017-12-04T19:45:31.975140", "is_default": true, } ] } |
Добавить каталог |
Список параметров:
Параметры | Тип | Описание | Обязательный |
---|---|---|---|
name | string | название нового каталога | да |
code | string | идентификатор каталога | да |
is_default | boolean | каталог отображаемый по умолчанию, по умолчанию false | нет |
Пример запроса
curl -XPOST "[endpoint]/catalogs/" -d '{"name": "New catalog", "code": "newcatalog"}' --H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
{ "id": 17, "name": "New catalog", "code": "newcatalog", "created": "2017-12-20T14:24:20.043638", "modified": "2017-12-20T14:24:20.043638", "is_default": false, } |
Получить указанный каталог |
Пример запроса
curl -XGET "[endpoint]/catalogs/17/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
{ "id": 17, "name": "New catalog", "code": "newcatalog", "created": "2017-12-20T14:24:20.043638", "modified": "2017-12-20T14:24:20.043638", "is_default": false, } |
Изменить каталог |
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
name | string | новое имя | нет |
code | string | новый идентификатор | нет |
is_default | boolean | отображать по умолчанию | нет |
Пример запроса
curl -XPATCH "[endpoint]catalogs/17/" -d '{"name": "Catalog1", "is_default": True}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
{ "id": 17, "name": "Catalog1", "code": "newcatalog", "created": "2017-12-20T14:24:20.043638", "modified": "2017-12-20T14:24:20.043638", "is_default": true, } |
Удаление каталога |
Пример запроса
curl -XDELETE "[endpoint]catalogs/17/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Получение необходимых данных для создания валидного каталога |
Пример запроса
curl -XOPTIONS "[endpoint]catalogs/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
{ "name":"Catalogs Categories List", "description":"", "renders":[ "application/json", "text/html" ], "parses":[ "application/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "actions":{ "POST":{ "id":{ "type":"integer", "required":false, "read_only":true, "label":"ID" }, "code":{ "type":"string", "required":true, "read_only":false, "label":"Catalog ID", "max_length":40 }, "name":{ "type":"string", "required":true, "read_only":false, "label":"Name", "max_length":200 }, "created":{ "type":"datetime", "required":false, "read_only":true, "label":"Created" }, "modified":{ "type":"datetime", "required":false, "read_only":true, "label":"Modified" }, "is_default":{ "type":"boolean", "required":false, "read_only":false, "label":"Catalog by default" }, } } } |