API Справочники
Работа со справочниками.
- Виды временных интервалов
- Виды груза
- Виды обратной доставки груза
- Виды паллет
- Виды плательщиков
- Виды плательщиков обратной доставки
- Виды упаковки
- Виды шин и дисков
- Описания груза
- Перечень ошибок
- Технологии доставки
- Типы контрагентов
- Формы оплаты
- Формы собственности
Типы контрагентов
Метод «getTypesOfCounterparties», работает в модели «Common», этот метод позволяет загрузить список типов контрагентов на украинском и на русском языках. Необходимо сохранять копию справочников на стороне клиента и поддерживать ее в актуальном состоянии. Рекомендуется проводить обновление справочников раз в месяц.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
(дополнительный)
string
Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойства метода |
{
"modelName": "Common",
"calledMethod": "getTypesOfCounterparties",
"apiKey": "[ВАШ КЛЮЧ]",
"methodProperties": {}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getTypesOfCounterparties</calledMethod>
<methodProperties />
<modelName>Common</modelName>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
Description | string[36] | Описание на Украинском |
{
"success": true,
"data": [
{
"Description": "Организация",
"Ref": "Organization"
},
{
"Description": "Частное лицо",
"Ref": "PrivatePerson"
}
],
"errors": [],
"warnings": [],
"info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Description>Организация</Description>
<Ref>Organization</Ref>
</item>
<item>
<Description>Частное лицо</Description>
<Ref>PrivatePerson</Ref>
</item>
</data>
<errors/>
<warnings/>
<info/>
</root>