Описание : Список всех возможных типов контактов персоны
Метод: GET
Ресурс: person/contact_type
Параметры:
start — с какой позиции начать отдавать элементы, по-умолчанию 0limit — сколько элементов отдавать, по-умолчанию 100, не может быть больше 1000
Ответ: Список типов, описанный следующей JSON-Schema:
JSON схема отдачи списка контактов
{
"type": "object",
"properties": {
"data": {
"description": "Массив типов контактов",
"type": "array",
"items": {
"description": "Тип контакта",
"type": "object",
"properties": {
"CONTACT_TYPE_ID": {
"description": "Уникальный идентификатор типа контактов",
"type": "string"
},
"DISPLAY_NAME": {
"description": "Названитие типа контакта",
"type": "string"
},
"LANGUAGE": {
"description": "Язык перевода",
"type": "string"
},
"MNEMO": {
"description": "Мнемонический индентификатор (используется в сущности контактов)",
"type": "string"
}
}
}
},
"meta": {
"description": "Дополнительные данные",
"type": "object",
"required": [
"totalCount",
"start",
"limit"
],
"properties": {
"totalCount": {
"description": "Общее количество",
"type": "integer"
},
"start": {
"description": "С какой позиции началось отдаваться",
"type": "integer"
},
"limit": {
"description": "Сколько всего отдалось",
"type": "integer"
}
}
}
}
}
|
Пример:
Запрос
GET /xapi/person/contact_type?start=0&limit=10
|