Versions Compared

Old Version 1

changes.mady.by.user Vasily Tashchilin

Saved on

compared with

New Version Current

changes.mady.by.user Vasily Tashchilin

Saved on

Key

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

GET catalogs/

Info
iconfalse

Получить список каталогов категорий

Список параметров:

ПараметрыТипОписаниеОбязательныйФормат
first_tsdateОтобразить каталоги измененные после заданного значениянетYYYY-MM-DD
last_tsdateОтобразить каталоги измененные до заданного значениянетYYYY-MM-DD


Пример запроса

Paste code macro
languagebash
themeDarkula
curl -XGET "[endpoint]/catalogs/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "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,
            "is_active": true,
        }
    ]
}


POST catalogs/

Info
iconfalse

Добавить каталог

Список параметров:

ПараметрыТипОписаниеОбязательный
namestringназвание нового каталогада
codestring

идентификатор каталога

да
is_defaultbooleanкаталог отображаемый по умолчанию, по умолчанию falseнет
is_active
booleanкаталог активен, по умолчанию trueнет


Пример запроса

Paste code macro
languagebash
themeDarkula
curl -XPOST "[endpoint]/catalogs/" -d '{"name": "New catalog", "code": "newcatalog"}' --H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json"

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "New catalog",
    "code": "newcatalog",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "is_default": false,
    "is_active": true,
}

GET catalogs/[id]/

Info
iconfalse

Получить указанный каталог


Пример запроса

Paste code macro
languagebash
themeDarkula
curl -XGET "[endpoint]/catalogs/17/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "New catalog",
    "code": "newcatalog",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "is_default": false, 
    "is_active": true,
}


PATCH catalogs/[id]/

Info
iconfalse

Изменить каталог

Список параметров:

ПараметрТипОписаниеОбязательный
namestringновое имянет
codestringновый идентификаторнет
is_defaultbooleanотображать по умолчаниюнетis_activebooleanкаталог активеннет


Пример запроса

Paste code macro
languagebash
themeDarkula
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"

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "Catalog1",
    "code": "newcatalog",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "is_default": true,
    "is_active": true,
}

DELETE catalogs/[id]/

Info
iconfalse

Удаление каталога

Пример запроса

Paste code macro
languagebash
themeDarkula
curl -XDELETE "[endpoint]catalogs/17/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

OPTIONS catalogs/

Info
iconfalse
Получение необходимых данных для создания валидного каталога

Пример запроса

Paste code macro
languagebash
themeDarkula
curl -XOPTIONS "[endpoint]catalogs/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

Ответ:

Paste code macro
languagejson
themeDarkula
{

    "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"
            },
            "is_active":{
                "type":"boolean",
                "required":false,
                "read_only":false,
                "label":"Active"
            },
        }
    }

}


Table of Contents
stylenone