API v1.0 - 5. Справочники пользователя
5.6. Получение списка контактных лиц получателя
Параметры запроса
Заголовки
Request URL
https://api.sat.ua/study/hs/api/v1.0/catalogs/ContactPerson/{format}/list
Содержимое ответа
URL-адрес запроса
Параметры запроса
| format | string | Формат данных для получения ответа (xml, json) | |
|
apiKey |
(дополнительный) |
string |
Ключ пользователя ТК САТ. Для получения ключа нужно пройти регистрацию. Ключ может быть передан как через параметр URL, так и в заголовке HTTP запроса В режиме тестирования без регистрации используйте ключ: devApiKey |
| ref |
(дополнительный) |
string |
Иидентификатор получателя |
| language | (дополнительный) | string |
Код языка для получения ответа (ru, en, uk) |
| searchString | (дополнительный) | string |
Поиск получателей груза по части наименования |
| searchPhone | (дополнительный) | string | Поиск получателей груза по номеру телефона |
| description | (дополнительный) |
string |
ФИО контактного лица получателя |
| phone |
(дополнительный) |
string |
Телефон контактного лица получателя |
| main |
(дополнительный) |
string |
Признак основного контактного лица получателя |
Ответ 200
Список контактных лиц получателей
- ref: идентификатор контактного лица получателя
- description: ФИО контактного лица получателя
- phone: телефон контактного лица получателя
Пример ответа
<response>
<success>true</success>
<data>
<item>
<ref>8f1eeac0-5893-11e5-9ad6-005056b13e62</ref>
<description>Кравцов Олег Игоревич</description>
<phone>+380632525252</phone>
</item>
</data>
</response>
[
{
"ref": "8f1eeac0-5893-11e5-9ad6-005056b13e62",
"description": "Кравцов Олег Игоревич",
"phone": "+380632525252",
}
]
