Добавление груза [1.0]

Описание

Добавление груза с помощью API. Перед добавлением происходит сначала проверка на возможность объединения грузов, а потом проверка на дублирование

Структура URL

HTTP метод: POST, ресурс: <base_url>/loads

Результат

Структура "Груз", описывающая добавленный груз.

Список параметров

Список всех параметров груза с их описанием вы можете посмотреть здесь: Описание структуры "груз"

НазваниеСпособ передачи параметраОбязательный
ContactId1BODY+
ContactId2BODY
NoteBODY
FirstDateBODY
LastDateBODY
DateTypeBODY
PeriodicityIdBODY
KrugoreisBODY
LoadingBODY+
ExtraPointsBODY
UnloadingBODY+
CargoBODY+
TransportBODY+
PaymentBODY+
StealthBODY
BoardsBODY
PriorityViewBODY
LoadMetaBODY
DealBODY
LoadFileBODY

Пример запроса и ответа

Запрос

POST, http://api.ati.su/loads

{
   "ContactId1":0,
   "ContactId2":null,
   "Note":"",
   "FirstDate":"2012-05-30T00:00:00",
   "LastDate":"2012-05-31T00:00:00",
   "DateType":1,
   "PeriodicityId":0,
   "Krugoreis":false,
   "Loading":{
      "CityId":22,
      "FiasID":"c2ca0dc5-acbf-4878-8a94-a9154650de46",
      "Latitude":null,
      "Longitude":null,
      "Street":"",
      "TimeStart":null,
      "TimeEnd":null,
      "LargeCities":[

      ]
   },
   "ExtraPoints":[

   ],
   "Unloading":{
      "CityId":0,
      "FiasID":"c2ca0dc5-acbf-4878-8a94-a9154650de46",
      "Latitude":null,
      "Longitude":null,
      "Street":"",
      "TimeStart":null,
      "TimeEnd":null,
      "LargeCities":[

      ]
   },
   "Cargo":{
      "Weight":12,
      "Volume":12,
      "ADR":0,
      "CargoTypeId":1,
      "CargoType":"",
      "PackType":0,
      "PalletCount":0,
      "BeltCount":0,
      "DogruzType":1,
      "SborGruz":false,
      "Size":{
         "Length":1,
         "Width":2,
         "Height":3,
         "LengthHighlight":false,
         "WidthHighlight":false,
         "HeightHighlight":false
      }
   },
   "Transport":{
      "CarType":2,
      "LoadingType":0,
      "LoadingLogicalOperator":"AND",
      "UnloadingType":1,
      "UnloadingLogicalOperator":"AND",
      "TrucksQuantity":1,
      "TemperatureFrom":null,
      "TemperatureTo":null,
      "Stsepka":false,
      "Pnevmohod":false,
      "Koniki":false,
      "TIR":false,
      "CMR":false,
      "T1":false,
      "SanPassport":false
   },
   "Payment":{
      "CurrencyId":2,
      "MoneyType":22,
      "RateSum":120000,
      "SumWithNDS":0,
      "SumWithoutNDS":0,
      "PrepayPercent":0,
      "PrepayPercentEnabled":false,
      "PayDays":0,
      "PayDaysEnabled":false,
      "FixedRate":true,
      "Torg":false,
      "DirectContract":false,
      "OnUnloading":false
   },
   "Stealth":{
      "FirmRegDateToHide":"2012-06-02T12:00:00"
   },
   "Boards":[
      {
         "BoardId":"57165a3dd3df9930241f5f24",
         "PublicationTime":"2016-08-11T11:40:55.063Z",
         "PublicationOption":0
      },
      {
         "BoardId":"57752dedbf80eb42d80668a8",
         "PublicationTime":null,
         "PublicationOption":3
      }
   ],
   "PriorityView":{
      "DailyLimit":5,
      "IsForPayedOnly":true,
      "OrderLimit":50,
      "ViewRate":0.5
   },
   "LoadMeta":{
      "LoadMetaId":"f10420a3-3e6d-462c-a90b-f22ec58ab4dc",
      "MetaData":"Данные груза"
   },
   "Deal":{
      "Auction":{
         "StartRate":5000,
         "Currency":1,
         "Step":500,
         "PaymentType":25,
         "Duration":1,
         "EndDate":"2020-06-27 08:51",
         "TimeToProvideDocuments":3,
         "StartSinceFirstBet":false,
         "AutoRenew":false,
         "RenewTime":1,
         "MaxRenewTime":1,
         "RaiseBid":false,
         "RaiseBidInterval":1,
         "MaxRate":9999999999,
         "WinnerCriterion":0,
         "AcceptSecondPayType":0,
         "Nds":20,
         "EndDateBoundary":null,
         "ResponseInMinutes":null,
         "AuctionRestartParameters":{
            "AuctionFinishAction":1,
            "InitRestartCount":1,
            "InitChangeWinnerCount":1
         }
      }
   },
   "LoadFiles":[
      {
         "Id":"7673cb31-b2ba-4b6a-a182-f7dfaac313c9",
         "FileType":"1",
         "Attributes":"0",
         "Name":"Документ-Doc-123456789 для загрузки..jpg",
         "Link":"https://d.ati.su/api/next/filestorage/7673cb31-b2ba-4b6a-a182-f7dfaac313c9/",
         "Size":"75527"
      }
   ]
}

Ответ

Если добавление прошло успешно, то вернется добавленный груз.

Список ответов сервера

Каждая ошибка кроме HTTP кода имеет уникальный строковый код. Подробнее..

HTTP код ответаКод ошибкиСообщение
200--Операция завершена успешно
202--Груз был объединен с другим грузом. Подробнее...
400json_validation_errorОшибка валидации груза
400deserialization_errorОшибка десериализации тела запроса
401--Требуется авторизация
403access_denied_errorОшибка доступа
409load_conflict_errorИмеется груз со схожими параметрами, добавление не происходит. Подробнее...