Адрес службы: GET
http://api.alemtat.kz/web/{ext}/Find/getWayBillsEvents?Numbers={Numbers}&DocNumber={DocNumber}&ApiKey={ApiKey}
Получаем информацию об отправлениях по номеру накладной относительно транспортного документа
Информация о запросе
URI параметры
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| Numbers |
Массив номеров через ';'. Ограничение в 50 номеров. |
string |
Required |
| DocNumber |
Номер транспортного документа (не обязательный параметр). |
string |
Required |
| ext |
Формат данных. JSON или XML. |
string |
Нет описания |
| ApiKey |
Выданный API-ключ |
string |
Обязательный Используется для получения доступа к данным |
Информация об ответе
Описание ответа
Возвращает коллекцию из объектов: Номер накладной - Транзитный номер - События - Дополнительная информация (Ключ - Значение)
| Наименование | Описание | Тип | Дополнительная информация |
|---|---|---|---|
| AWBN |
Номер накладной |
string |
Нет описания |
| TransitNumber |
Транзитный номер |
string |
Нет описания |
| Status |
Статус |
string |
Нет описания |
| Weight |
Фактический вес |
decimal number |
Нет описания |
| Events |
События |
Коллекция из WayBillEventAPI |
Нет описания |
| AdditionInfo |
Дополнительная информация Ключ - Значение |
Dictionary of string [key] and string [value] |
Нет описания |
Форматы ответа
application/json, text/json
Пример:
[
{
"AWBN": "sample string 1",
"TransitNumber": "sample string 2",
"Status": "sample string 3",
"Weight": 4.0,
"Events": [
{
"LocalCode": "sample string 1",
"EventName": "sample string 2",
"EventKind": "sample string 3",
"Description": "sample string 4",
"EventDate": "sample string 5",
"EventTime": "sample string 6",
"StationCode": "sample string 7"
},
{
"LocalCode": "sample string 1",
"EventName": "sample string 2",
"EventKind": "sample string 3",
"Description": "sample string 4",
"EventDate": "sample string 5",
"EventTime": "sample string 6",
"StationCode": "sample string 7"
}
],
"AdditionInfo": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"AWBN": "sample string 1",
"TransitNumber": "sample string 2",
"Status": "sample string 3",
"Weight": 4.0,
"Events": [
{
"LocalCode": "sample string 1",
"EventName": "sample string 2",
"EventKind": "sample string 3",
"Description": "sample string 4",
"EventDate": "sample string 5",
"EventTime": "sample string 6",
"StationCode": "sample string 7"
},
{
"LocalCode": "sample string 1",
"EventName": "sample string 2",
"EventKind": "sample string 3",
"Description": "sample string 4",
"EventDate": "sample string 5",
"EventTime": "sample string 6",
"StationCode": "sample string 7"
}
],
"AdditionInfo": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
]
application/xml, text/xml
Пример:
<ArrayOfWayBillsEventsAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
<WayBillsEventsAPI>
<AWBN>sample string 1</AWBN>
<AdditionInfo xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</AdditionInfo>
<Events>
<WayBillEventAPI>
<Description>sample string 4</Description>
<EventDate>sample string 5</EventDate>
<EventKind>sample string 3</EventKind>
<EventName>sample string 2</EventName>
<EventTime>sample string 6</EventTime>
<LocalCode>sample string 1</LocalCode>
<StationCode>sample string 7</StationCode>
</WayBillEventAPI>
<WayBillEventAPI>
<Description>sample string 4</Description>
<EventDate>sample string 5</EventDate>
<EventKind>sample string 3</EventKind>
<EventName>sample string 2</EventName>
<EventTime>sample string 6</EventTime>
<LocalCode>sample string 1</LocalCode>
<StationCode>sample string 7</StationCode>
</WayBillEventAPI>
</Events>
<Status>sample string 3</Status>
<TransitNumber>sample string 2</TransitNumber>
<Weight>4</Weight>
</WayBillsEventsAPI>
<WayBillsEventsAPI>
<AWBN>sample string 1</AWBN>
<AdditionInfo xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</AdditionInfo>
<Events>
<WayBillEventAPI>
<Description>sample string 4</Description>
<EventDate>sample string 5</EventDate>
<EventKind>sample string 3</EventKind>
<EventName>sample string 2</EventName>
<EventTime>sample string 6</EventTime>
<LocalCode>sample string 1</LocalCode>
<StationCode>sample string 7</StationCode>
</WayBillEventAPI>
<WayBillEventAPI>
<Description>sample string 4</Description>
<EventDate>sample string 5</EventDate>
<EventKind>sample string 3</EventKind>
<EventName>sample string 2</EventName>
<EventTime>sample string 6</EventTime>
<LocalCode>sample string 1</LocalCode>
<StationCode>sample string 7</StationCode>
</WayBillEventAPI>
</Events>
<Status>sample string 3</Status>
<TransitNumber>sample string 2</TransitNumber>
<Weight>4</Weight>
</WayBillsEventsAPI>
</ArrayOfWayBillsEventsAPI>