POST {ext}/Find/getWayBill

Адрес службы: POST

http://api.alemtat.kz/web/{ext}/Find/getWayBill

Получаем информацию об отправлениях по номеру накладной

Информация о запросе

URI параметры

Наименование	Описание	Тип	Дополнительная информация
ext	Формат данных. JSON или XML.	string	Нет описания

Параметры запроса

Параметры накладной

Наименование	Описание	Тип	Дополнительная информация
Number	Номер накладной	string	Нет описания
ApiKey	Выданный API-ключ	string	Обязательный Используется для получения доступа к данным

Наименование

Описание

Тип

Дополнительная информация

Number

Номер накладной

string

Нет описания

ApiKey

Выданный API-ключ

string

Обязательный

Используется для получения доступа к данным

Форматы запроса

application/json, text/json

Пример:

{
  "Number": "sample string 1"
}

application/xml, text/xml

Пример:

<ParamWayBill xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <Number>sample string 1</Number>
</ParamWayBill>

$.ajax({
    type: 'POST',
    url: 'http://api.alemtat.kz/web/json/Find/getWayBill',
    dataType: 'json',
    data: { ApiKey: 'Выданный API-ключ', Number: '20022007' }
	success: function (data) {
        console.log(data);
    },
    error: function(xhr, status) {
        console.log(xhr.status + ': ' + xhr.statusText);
    }
});

$kv = array();
$kv['Number'] = '20022007';
$kv['ApiKey'] = 'Выданный API-ключ';
$postdata = http_build_query($kv);
$opts = array('http' =>
	array(
	    'method'  => 'POST',
	    'header'  => 'Content-type: application/x-www-form-urlencoded',
	    'content' => $postdata
	)
);
$context = stream_context_create($opts);
$result = file_get_contents('http://api.alemtat.kz/web/json/Find/getWayBill', false, $context);
echo $result;

Информация об ответе

Описание ответа

Возвращает информацию об накладной и всех ее отправлениях

Наименование	Описание	Тип	Дополнительная информация
Id	Id отправления	string	Нет описания
Number	Номер отправления	string	Нет описания
PickUpTime	Дата регистрации	string	Нет описания
SenderName	Отправитель	string	Нет описания
FromLocal	Пункт отправления	string	Нет описания
ToLocal	Пункт назначения	string	Нет описания
Places	Количество мест	integer	Нет описания
CurrentState	Текущее состояние	string	Нет описания
IsDelivered	Статус доставки	boolean	Нет описания
Shipments	Места	Коллекция из Shipment	Нет описания

Форматы ответа

application/json, text/json

Пример:

{
  "Id": "sample string 1",
  "Number": "sample string 2",
  "PickUpTime": "sample string 3",
  "SenderName": "sample string 4",
  "FromLocal": "sample string 5",
  "ToLocal": "sample string 6",
  "Places": 7,
  "CurrentState": "sample string 8",
  "IsDelivered": true,
  "Shipments": [
    {
      "Id": "sample string 1",
      "Number": "sample string 2",
      "Events": [
        {
          "DateDelivery": "sample string 1",
          "TimeDelivery": "sample string 2",
          "ToName": "sample string 3",
          "CodeName": "sample string 4",
          "CodeType": "sample string 5",
          "Comment": "sample string 6",
          "Company": "sample string 7",
          "Station": "sample string 8",
          "ToLocal": "sample string 9"
        },
        {
          "DateDelivery": "sample string 1",
          "TimeDelivery": "sample string 2",
          "ToName": "sample string 3",
          "CodeName": "sample string 4",
          "CodeType": "sample string 5",
          "Comment": "sample string 6",
          "Company": "sample string 7",
          "Station": "sample string 8",
          "ToLocal": "sample string 9"
        }
      ]
    },
    {
      "Id": "sample string 1",
      "Number": "sample string 2",
      "Events": [
        {
          "DateDelivery": "sample string 1",
          "TimeDelivery": "sample string 2",
          "ToName": "sample string 3",
          "CodeName": "sample string 4",
          "CodeType": "sample string 5",
          "Comment": "sample string 6",
          "Company": "sample string 7",
          "Station": "sample string 8",
          "ToLocal": "sample string 9"
        },
        {
          "DateDelivery": "sample string 1",
          "TimeDelivery": "sample string 2",
          "ToName": "sample string 3",
          "CodeName": "sample string 4",
          "CodeType": "sample string 5",
          "Comment": "sample string 6",
          "Company": "sample string 7",
          "Station": "sample string 8",
          "ToLocal": "sample string 9"
        }
      ]
    }
  ]
}

application/xml, text/xml

Пример:

<WayBillAPI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <CurrentState>sample string 8</CurrentState>
  <FromLocal>sample string 5</FromLocal>
  <Id>sample string 1</Id>
  <IsDelivered>true</IsDelivered>
  <Number>sample string 2</Number>
  <PickUpTime>sample string 3</PickUpTime>
  <Places>7</Places>
  <SenderName>sample string 4</SenderName>
  <Shipments>
    <ShipmentAPI>
      <Events>
        <EventShipmentAPI>
          <CodeName>sample string 4</CodeName>
          <CodeType>sample string 5</CodeType>
          <Comment>sample string 6</Comment>
          <Company>sample string 7</Company>
          <DateDelivery>sample string 1</DateDelivery>
          <Station>sample string 8</Station>
          <TimeDelivery>sample string 2</TimeDelivery>
          <ToLocal>sample string 9</ToLocal>
          <ToName>sample string 3</ToName>
        </EventShipmentAPI>
        <EventShipmentAPI>
          <CodeName>sample string 4</CodeName>
          <CodeType>sample string 5</CodeType>
          <Comment>sample string 6</Comment>
          <Company>sample string 7</Company>
          <DateDelivery>sample string 1</DateDelivery>
          <Station>sample string 8</Station>
          <TimeDelivery>sample string 2</TimeDelivery>
          <ToLocal>sample string 9</ToLocal>
          <ToName>sample string 3</ToName>
        </EventShipmentAPI>
      </Events>
      <Id>sample string 1</Id>
      <Number>sample string 2</Number>
    </ShipmentAPI>
    <ShipmentAPI>
      <Events>
        <EventShipmentAPI>
          <CodeName>sample string 4</CodeName>
          <CodeType>sample string 5</CodeType>
          <Comment>sample string 6</Comment>
          <Company>sample string 7</Company>
          <DateDelivery>sample string 1</DateDelivery>
          <Station>sample string 8</Station>
          <TimeDelivery>sample string 2</TimeDelivery>
          <ToLocal>sample string 9</ToLocal>
          <ToName>sample string 3</ToName>
        </EventShipmentAPI>
        <EventShipmentAPI>
          <CodeName>sample string 4</CodeName>
          <CodeType>sample string 5</CodeType>
          <Comment>sample string 6</Comment>
          <Company>sample string 7</Company>
          <DateDelivery>sample string 1</DateDelivery>
          <Station>sample string 8</Station>
          <TimeDelivery>sample string 2</TimeDelivery>
          <ToLocal>sample string 9</ToLocal>
          <ToName>sample string 3</ToName>
        </EventShipmentAPI>
      </Events>
      <Id>sample string 1</Id>
      <Number>sample string 2</Number>
    </ShipmentAPI>
  </Shipments>
  <ToLocal>sample string 6</ToLocal>
</WayBillAPI>