GET api/Tariff?includeDisabled={includeDisabled}
Получить список тарифов
Описание запроса
Параметры URI
Имя | Описание | Тип | Дополнительная информация |
---|---|---|---|
includeDisabled |
Флаг "Получать архивные тарифы" |
boolean |
Значение по умолчанию True |
Параметры запроса
Нет
Описание ответа
Описание ресурса
Список всех тарифов, действующих в системе
Коллекция TariffViewИмя | Описание | Тип | Дополнительная информация |
---|---|---|---|
Id |
Поле Id содержит идентификатор тарифа |
integer |
Нет |
TariffTypeId |
Поле Id содержит идентификатор типа тарифа |
byte |
Нет |
Name |
Поле Name содержит наименование тарифа |
string |
Нет |
Price |
Поле Price содержит стоимость тарифа в рублях (стоимость указана за сутки или за количество запросов и зависит от типа тарифа) |
decimal |
Нет |
MaximumRequestsCount |
Поле MaximumRequestsCount содержит количество разрешенных запросов (тарифицируются только запросы на получение цен и остатков) или null в случае подневной тарификации |
integer |
Нет |
Disabled |
Поле Disabled содержит информацию о состоянии тарифа (архивный / действующий) |
boolean |
Нет |
Форматы ответа
application/json, text/json
Пример:
[ { "Id": 1, "TariffTypeId": 64, "Name": "sample string 3", "Price": 4.0, "MaximumRequestsCount": 1, "Disabled": true }, { "Id": 1, "TariffTypeId": 64, "Name": "sample string 3", "Price": 4.0, "MaximumRequestsCount": 1, "Disabled": true } ]
application/xml, text/xml
Пример:
<ArrayOfTariffView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SupplierProviderHost.Models"> <TariffView> <Disabled>true</Disabled> <Id>1</Id> <MaximumRequestsCount>1</MaximumRequestsCount> <Name>sample string 3</Name> <Price>4</Price> <TariffTypeId>64</TariffTypeId> </TariffView> <TariffView> <Disabled>true</Disabled> <Id>1</Id> <MaximumRequestsCount>1</MaximumRequestsCount> <Name>sample string 3</Name> <Price>4</Price> <TariffTypeId>64</TariffTypeId> </TariffView> </ArrayOfTariffView>