Просмотреть исходный

Описание : Список всех возможных статусов персон

Метод: GET

Ресурс: person/status

Параметры:

start — с какой позиции начать отдавать элементы, по-умолчанию 0
limit — сколько элементов отдавать, по-умолчанию 100, не может быть больше 1000

Ответ: Список статусов, описанный следующей JSON-Schema:

JSON схема отдачи списка статусов

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "data": {
            "description": "Массив статусов",
            "type": "array",
            "items": {
                "description": "Статус персоны",
                "type": "object",
                "required": [
                    "IDENTITY_STATUS_ID",
                    "CREATE_DATE",
                    "CHANGE_DATE",
                    "ASSIGNMENT_DATE",
                    "DISPLAY_NAME",
                    "COLOR",
                    "EDITABLE"
                ],
                "properties": {
                    "IDENTITY_STATUS_ID": {
                        "description": "Уникальный идентификатор статуса",
                        "type": "string"
                    },
                    "CREATE_DATE": {
                        "description": "Дата создания статуса",
                        "type": "string"
                    },
                    "CHANGE_DATE": {
                        "description": "Дата изменения статуса",
                        "type": "string"
                    },
                    "ASSIGNMENT_DATE": {
                        "description": "Дата проставления статуса персоне",
                        "type": "string"
                    },
                    "DISPLAY_NAME": {
                        "description": "Название статуса",
                        "type": "string"
                    },
                    "COLOR": {
                        "description": "Цвет статуса (например #ff0000)",
                        "type": "string"
                    },
                    "EDITABLE": {
                        "description": "Признак, что статус не является системным",
                        "type": "integer"
                    }
                }
            }
        },
        "meta": {
            "description": "Дополнительные данные",
            "type": "object",
            "required": [
                "totalCount",
                "start",
                "limit"
            ],
            "properties": {
                "totalCount": {
                    "description": "Общее количество",
                    "type": "integer"
                },
                "start": {
                    "description": "С какой позиции началось отдаваться",
                    "type": "integer"
                },
                "limit": {
                    "description": "Сколько всего отдалось",
                    "type": "integer"
                }
            }
        }
    }
}

Пример:

Запрос

GET /xapi/person/status?start=0&limit=10