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