GET api/Dictionary?UserGuid={UserGuid}&ApiKey={ApiKey}
Возвращает информацию о контрагентах. В том числе Код контрагента, необходимый для заказа
Информация о запросе
URI параметры
| Имя | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| UserGuid |
Ваш UserGuid |
string |
Required |
| ApiKey |
Ваш ApiKey |
string |
Required |
Параметры тела запроса
Нет.
Информация об ответе
Описание ресурсов
ContragentsResponse| Имя | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| Contragents |
Список контрагентов |
Коллекция Contragent |
Нет. |
| IsError |
Указывает завершился ли запрос с ошибкой или нет |
boolean |
Нет. |
| ErrorMessage |
Сообщение об ошибке |
string |
Нет. |
Форматы ответа
application/json, text/json
Пример:
{
"Contragents": [
{
"ConragentName": "sample string 1",
"ContragentGuid": "sample string 2",
"CurrencyCode": "sample string 3"
},
{
"ConragentName": "sample string 1",
"ContragentGuid": "sample string 2",
"CurrencyCode": "sample string 3"
}
],
"IsError": true,
"ErrorMessage": "sample string 2"
}
multipart/form-data
Пример:
{"Contragents":[{"ConragentName":"sample string 1","ContragentGuid":"sample string 2","CurrencyCode":"sample string 3"},{"ConragentName":"sample string 1","ContragentGuid":"sample string 2","CurrencyCode":"sample string 3"}],"IsError":true,"ErrorMessage":"sample string 2"}
application/xml, text/xml
Пример:
<ContragentsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<IsError>true</IsError>
<ErrorMessage>sample string 2</ErrorMessage>
<Contragents>
<Contragent>
<ConragentName>sample string 1</ConragentName>
<ContragentGuid>sample string 2</ContragentGuid>
<CurrencyCode>sample string 3</CurrencyCode>
</Contragent>
<Contragent>
<ConragentName>sample string 1</ConragentName>
<ContragentGuid>sample string 2</ContragentGuid>
<CurrencyCode>sample string 3</CurrencyCode>
</Contragent>
</Contragents>
</ContragentsResponse>