Задать порядок задач рейса

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

Измените порядок погрузки или выгрузки задач рейса. Для каждой задачи передайте flightTaskId, позицию order и тип операции orderType в data.flightOrders. Проверьте data.success в ответе.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

POST

https://partner-test-yamagistrali.ru/api/flights/order/setBulk/v1

Тестовый стенд

Body

application/json
{
  "data": {
    "flightOrders": [
      {
        "flightTaskId": "example",
        "order": 0,
        "orderType": "example"
      }
    ]
  }
}

Name

Description

data

Type: FlightOrderSetBulkV1Request

Example
{
  "flightOrders": [
    {
      "flightTaskId": "example",
      "order": 0,
      "orderType": "example"
    }
  ]
}

FlightOrderSetBulkV1FlightOrder

Name

Description

flightTaskId

Type: string

Example: example

order

Type: integer

orderType

Type: string

Example: example

Example
{
  "flightTaskId": "example",
  "order": 0,
  "orderType": "example"
}

FlightOrderSetBulkV1Request

Name

Description

flightOrders

Type: FlightOrderSetBulkV1FlightOrder[] | null

Example
[
  {
    "flightTaskId": "example",
    "order": 0,
    "orderType": "example"
  }
]
Example
{
  "flightOrders": [
    {
      "flightTaskId": "example",
      "order": 0,
      "orderType": "example"
    }
  ]
}

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "success": true
  }
}

Name

Description

data

Type: FlightOrderSetBulkV1Response

Example
{
  "success": true
}

FlightOrderSetBulkV1Response

Name

Description

success

Type: boolean

Example
{
  "success": true
}

400 Bad Request

Bad Request

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

Error

Name

Description

info

Type: object

Example
{}

message

Type: string

Example: example

message_code

Type: string

Example: example

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

403 Forbidden

Forbidden

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

500 Internal Server Error

Internal Server Error

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}