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

http://api.alemtat.kz/web/{ext}/CourierRequest/CourierRequest


Регистрация заявки на вызов курьера.

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

URI параметры

НаименованиеОписаниеТипДополнительная информация
ext

Формат данных. JSON или XML.

 string

Нет описания

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

НаименованиеОписаниеТипДополнительная информация
Date

Дата заявки. Формат: "yyyy-MM-dd", не может быть меньше текущей даты. По умолчанию текущая дата.

 string

Нет описания
Card

Номер карты клиента согласно договора, обязателен к заполненияю.

 string

Нет описания
SenderName

Название компании отправителя, обязателен к заполнению имеет ограничение в 128 символов.

 string

Нет описания
Lunch

Обеденое время. Варианты заполнения(без обеда||12:00-13:00||12:00-14:00 ||13:00-14:00), по умолчанию "без обеда". Максимально может содержать 12 символов.

 string

Нет описания
LocalityCode

Локальный код населеного пунка где необходимо произвести забор отправлений. Обязателен для заполнения, ограничен списком нахождения обслуживающих станций (метод: getStation, параметр: LocalCode).

 string

Нет описания
AddressDetail

Детальный адрес. Содержит описание адреса внутри указаного населеного пункта (улица, дом, квартира, офис). Обязателен для заполнения. Имеет ограничение на 512 символов.

 string

Нет описания
ContactName

Контактное лицо. Обязательный для заполнения. Имеет ограничение в 128 символов.

 string

Нет описания
Phone

Телефон контактного лица. Обязательный для заполнения. Имеет ограничение в 32 символа.

 string

Нет описания
ReadyFor

Информация о времени готовности отправлений к передаче их курьеру. Варианты заполнения (готово||12:00||13:00||14:00||15:00||16:00||17:00||18:00). По умолчанию "готово". Имеет ограничение в 6 символов.

 string

Нет описания
PickUp

Время до которого необходимо забрать отправления. Варианты заполнения (12:00||13:00||14:00||15:00||16:00||17:00||18:00). По умолчанию "18:00". Имеет ограничение в 6 символов.

 string

Нет описания
Service

Код услуги которая будет использоваться при доставке передаваемых отправлений. Согласно справочника услуг.

 string

Нет описания
IsLargeVolume

Признак наличия объемных отправлений. Объемным отправлением считается отправление у которого одна из сторон более 50 см.

 boolean

Нет описания
IsLargeWeight

Признак наличия тяжолых отправлений. Тяжелым отправлением считается отправление имеющее вес более 25 кг.

 boolean

Нет описания
Note

Особые заметки или условия по передаваемым отправлениям.

 string

Нет описания
ApiKey

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

 string

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

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

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

application/json, text/json

Пример: 
{
  "Date": "sample string 1",
  "Card": "sample string 2",
  "SenderName": "sample string 3",
  "Lunch": "sample string 4",
  "LocalityCode": "sample string 5",
  "AddressDetail": "sample string 6",
  "ContactName": "sample string 7",
  "Phone": "sample string 8",
  "ReadyFor": "sample string 9",
  "PickUp": "sample string 10",
  "Service": "sample string 11",
  "IsLargeVolume": true,
  "IsLargeWeight": true,
  "Note": "sample string 14"
}

application/xml, text/xml

Пример: 
<ParamCourierRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <AddressDetail>sample string 6</AddressDetail>
  <Card>sample string 2</Card>
  <ContactName>sample string 7</ContactName>
  <Date>sample string 1</Date>
  <IsLargeVolume>true</IsLargeVolume>
  <IsLargeWeight>true</IsLargeWeight>
  <LocalityCode>sample string 5</LocalityCode>
  <Lunch>sample string 4</Lunch>
  <Note>sample string 14</Note>
  <Phone>sample string 8</Phone>
  <PickUp>sample string 10</PickUp>
  <ReadyFor>sample string 9</ReadyFor>
  <SenderName>sample string 3</SenderName>
  <Service>sample string 11</Service>
</ParamCourierRequest>

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

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

НаименованиеОписаниеТипДополнительная информация
RequestId

Идентификатор принятой заявки.

 globally unique identifier

Нет описания
IsError

Признак ошибки

 boolean

Нет описания
ErrorCode

Код ошибки

 integer

Нет описания
Message

Описание ошибки

 string

Нет описания

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

application/json, text/json

Пример: 
{
  "RequestId": "b72770c8-f165-42b2-857f-4f7f539f6293",
  "IsError": true,
  "ErrorCode": 3,
  "Message": "sample string 4"
}

application/xml, text/xml

Пример: 
<ResultCourierRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALES.WebAPI.Models">
  <ErrorCode>3</ErrorCode>
  <IsError>true</IsError>
  <Message>sample string 4</Message>
  <RequestId>b72770c8-f165-42b2-857f-4f7f539f6293</RequestId>
</ResultCourierRequest>