Адрес службы: GET
http://api.alemtat.kz/web/{ext}/CourierRequest/CourierRequestList?Skip={Skip}&Take={Take}&ApiKey={ApiKey}
Получить список заявок. Список имеет обратный порядок (В начале указаны последнии заявки). Если не указывать параметры Skip и Take, метод вернет 5 последних заявок.
Информация о запросе
URI параметры
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| Skip |
Пропустить. Кол-во записей которое необходимо пропустить в результирующей выборке. По умолчанию имеет значение "0". |
integer |
Default value is 0 |
| Take |
Кол-во записей в результирующей выборке. По умолчанию имеет значение "5". Не может превышать заначение "100". |
integer |
Default value is 5 |
| ext |
Формат данных. JSON или XML. |
string |
Нет описания |
| ApiKey |
Выданный API-ключ |
string |
Обязательный Используется для получения доступа к данным |
Информация об ответе
Описание ответа
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| FullCount |
Кол-во записей всего. |
integer |
Нет описания |
| Skipped |
Кол-во пропущеных записей. |
integer |
Нет описания |
| Count |
Кол-во записей в полученом списке. |
integer |
Нет описания |
| Items |
Список запрашиваемых заявок. |
Коллекция из CourierRequestShortInfo |
Нет описания |
Форматы ответа
application/json, text/json
Пример:
{
"FullCount": 1,
"Skipped": 2,
"Count": 3,
"Items": [
{
"RequestId": "26e54f15-3396-499b-adeb-58fa58cbdf8d",
"Number": "sample string 2",
"Date": "sample string 3",
"Card": "sample string 4",
"SenderName": "sample string 5",
"LocalityCode": "sample string 6",
"AddressDetail": "sample string 7",
"Status": 0
},
{
"RequestId": "26e54f15-3396-499b-adeb-58fa58cbdf8d",
"Number": "sample string 2",
"Date": "sample string 3",
"Card": "sample string 4",
"SenderName": "sample string 5",
"LocalityCode": "sample string 6",
"AddressDetail": "sample string 7",
"Status": 0
}
]
}
application/xml, text/xml
Пример:
<ResultCourierRequestList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<Count>3</Count>
<FullCount>1</FullCount>
<Items>
<CourierRequestShortInfo>
<AddressDetail>sample string 7</AddressDetail>
<Card>sample string 4</Card>
<Date>sample string 3</Date>
<LocalityCode>sample string 6</LocalityCode>
<Number>sample string 2</Number>
<RequestId>26e54f15-3396-499b-adeb-58fa58cbdf8d</RequestId>
<SenderName>sample string 5</SenderName>
<Status>InWork</Status>
</CourierRequestShortInfo>
<CourierRequestShortInfo>
<AddressDetail>sample string 7</AddressDetail>
<Card>sample string 4</Card>
<Date>sample string 3</Date>
<LocalityCode>sample string 6</LocalityCode>
<Number>sample string 2</Number>
<RequestId>26e54f15-3396-499b-adeb-58fa58cbdf8d</RequestId>
<SenderName>sample string 5</SenderName>
<Status>InWork</Status>
</CourierRequestShortInfo>
</Items>
<Skipped>2</Skipped>
</ResultCourierRequestList>