Versions Compared

Old Version 6

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 categories/

Info
iconfalse

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

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

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


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

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

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3,
            "name": "Новая категория",
            "created": "2017-12-04T19:45:31.975140",
            "modified": "2017-12-04T19:45:31.975140",
            "parent": null,
            "is_active": true,
            "depth_level": 0,
            "catalog": 1,
            "children": [
                {
                    "id": 4,
                    "name": "New node",
                    "created": "2017-12-04T19:45:36.353663",
                    "modified": "2017-12-04T19:45:36.353663",
                    "parent": 3,
                    "is_active": true,
                    "depth_level": 1,
                    "catalog": 1,
                    "children": [
                        {
                            "id": 5,
                            "name": "New node",
                            "created": "2017-12-04T19:45:39.426119",
                            "modified": "2017-12-04T19:45:39.426119",
                            "parent": 4,
                            "is_active": true,
                            "depth_level": 2,
                            "catalog": 1,
                            "children": []
                        }
                    ]
                }
			]
		}
	}
           ]
        }
    ]
}


POST categories/

Info
iconfalse

Добавить категорию

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

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

идентификатор родителя категории, в которую будет добавлена новая, если не задана, то категория будет создана в корне

нет
undeletablebooleanсоздать ли неудаляемую категорию, по умолчанию falseнет
catalog
intидентификатор каталога, по умолчанию masterнет


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

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

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "New category",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "parent": null,
    "is_active": true,
    "depth_level": 0,
    "catalog": 1,
}

GET categories/[id]/

Info
iconfalse

Получить указанную категорию

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

ПараметрТипОписаниеОбязательный
flatbooleanОтображать плоскую структуру или древовидную, по умолчанию false нет


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

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

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "New category",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "parent": null,
    "is_active": true
    "depth_level": 0,
    "catalog": 1,
}


PATCH categories/[id]/

Info
iconfalse

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

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

ПараметрТипОписаниеОбязательный
namestringновое имянет
parentintкатегория, в которую перенести текущуюнет
undeletablebooleanнеудаляемая категориянет


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

Paste code macro
languagebash
themeDarkula
curl -XPATCH "[endpoint]categories/17/" -d '{"name": "name", "parent": 5}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json"

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "id": 17,
    "name": "name",
    "created": "2017-12-20T14:24:20.043638",
    "modified": "2017-12-20T14:24:20.043638",
    "parent": 5,
    "is_active": true,
    "depth_level": 1,
    "catalog": 1,
}

DELETE categories/[id]/

Info
iconfalse

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

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

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

OPTIONS categories/

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

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

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

Ответ:

Paste code macro
languagejson
themeDarkula
{
    "name": "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"
            },
            "name": {
                "type": "string",
                "required": true,
                "read_only": false,
                "label": "Имя",
                "max_length": 200
            },
            "created": {
                "type": "datetime",
                "required": false,
                "read_only": true,
                "label": "Создан"
            },
            "modified": {
                "type": "datetime",
                "required": false,
                "read_only": true,
                "label": "Изменён"
            },
            "depth_level": {
                "type": "field",
                "required": false,
                "read_only": true,
                "label": "Depth level"
            },
            "parent": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Родитель"
            },
            "is_active": {
                "type": "boolean",
                "required": false,
                "read_only": false,
                "label": "Is active"
            },
            "undeletable": {
                "type": "boolean",
                "required": false,
                "read_only": false,
                "label": "Неудаляемая категория"
            },
            "catalog": {
                "type": "field",
                "required": false,
                "read_only": false,
                "label": "Каталог"
			
            }
        }
    }
}


Table of Contents
stylenone