API V1.0 – 5.6. ОТРИМАННЯ СПИСКУ КОНТАКТНИХ ОСІБ ОДЕРЖУВАЧА
URL-Адреса запиту:
https://api.sat.ua/study/hs/api/v1.0/catalogs/ContactPerson/{format}/list?apiKey={apiKey}&ref={ref}[&language][&searchString][&searchPhone]Параметри запиту:
format
string
Формат даних для отримання відповіді (xml, json)
apiKey (додатковий)
string
Ключ користувача ТК САТ. Для отримання ключа потрібно пройти реєстрацію. Ключ може бути переданий як через параметр URL, так і в заголовку HTTP запиту У режимі тестування без реєстрації використовуйте ключ: devApiKey
language (додатковий)
string
Код мови для отримання відповіді (ru, en, uk)
searchString (додатковий)
string
Пошук одержувачів вантажу за частиною найменування
searchPhone (додатковий)
string
Пошук одержувачів вантажу за номером телефону
description (додатковий)
string
ПІБ контактної особи одержувача
phone (додатковий)
string
Телефон контактної особи одержувача
main (додатковий)
string
Ознака основної контактної особи одержувача
Відповідь 200
Список контактних осіб одержувачів
-
ref:
ідентифікатор контактної особи одержувача
-
description:
ПІБ контактної особи одержувача
-
phone:
телефон контактної особи одержувача
приклад відповіді
text/xml
| application/json
<response>
<success>true</success>
<data>
<item>
<ref>8f1eeac0-5893-11e5-9ad6-005056b13e62</ref>
<description>Кравцов Олег Игоревич</description>
<phone>+380632525252</phone>
</item>
</data>
</response>
інтерфейси API