Методы для работы с площадками погрузки-выгрузки

Добавление или изменение площадки погрузки-выгрузки

Чтобы изменить существующую площадку погрузки-выгрузки, надо передать поле id с ее идентификатором. Если id не передать, то будет создана новая площадка погрузки-выгрузки. В ответ на запрос возвращается созданная или изменённая площадка погрузки-выгрузки.

post

/gw/timeslots/api/v1/terminal

Развернуть все Свернуть все

body

object

{...}

id: integer

Идентификатор площадки погрузки-выгрузки

gates:[{}]

Список ворот площадки погрузки-выгрузки

schedule*:[{...}]

Расписание работы площадки погрузки-выгрузки

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

contacts*:[{...}]

Контактные данные ответственных лиц

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

name*: string

Название площадки погрузки-выгрузки

gates_count*: integer

Количество ворот

loading_type*: enum

[any, gates, up, lateral]

Тип загрузки

date_creation: string

Дата создания площадки погрузки-выгрузки

date_modified: string

Дата изменения площадки погрузки-выгрузки

deleted: boolean

Флаг, указывающий существует ли площадка погрузки-выгрузки или была удалена

is_test: boolean

Флаг, указывающий является ли площадка погрузки-выгрузки тестовой

warehouse*: integer

Идентификатор склада

}

CURL

Копировать

Пример ответа

Ответ

200 Возвращается созданная или обновленная площадка погрузки-выгрузки

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":{...}

"terminal":{...}

"id":35262,

"gates":[],

"schedule":[...],

{...}

"day_of_week":"1",

"time_from":"00:00:00",

"time_to":"23:59:00"

}

"contacts":[...],

{...}

"id":35498,

"name":"Имя менеджера склада",

"phone":"+7 000 000-00-00",

"country_phone_id":"0"

}

"name":"Тестовая площадка",

"gates_count":3,

"loading_type":"any",

"date_creation":"2023-07-04T08:09:18.676843+03:00",

"date_modified":"2023-07-04T08:09:18.676871+03:00",

"deleted":false,

"is_test":true,

"warehouse":34824

}

{...}

ok: boolean

result:{...}

terminal:{...}

id: integer

Идентификатор площадки погрузки-выгрузки

gates:[{}]

Список ворот площадки погрузки-выгрузки

schedule*:[{...}]

Расписание работы площадки погрузки-выгрузки

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

contacts*:[{...}]

Контактные данные ответственных лиц

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

name*: string

Название площадки погрузки-выгрузки

gates_count*: integer

Количество ворот

loading_type*: enum

[any, gates, up, lateral]

Тип загрузки

date_creation: string

Дата создания площадки погрузки-выгрузки

date_modified: string

Дата изменения площадки погрузки-выгрузки

deleted: boolean

Флаг, указывающий существует ли площадка погрузки-выгрузки или была удалена

is_test: boolean

Флаг, указывающий является ли площадка погрузки-выгрузки тестовой

warehouse*: integer

Идентификатор склада

}

400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"multiple_errors",

"error_list":[...],

{...},

"error":"loading_type",

"reason":"Значения test нет среди допустимых вариантов."

{...}

"error":"warehouse",

"reason":"Некорректный тип. Ожидалось значение первичного ключа, получен str."

}

"reason":"invalid"

}

ANY-OF

1:{...}

Одиночная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}

2:{...}

Множественная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

error_list:[{...}]

Список возникших ошибок

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Получение площадок погрузки-выгрузки

Возвращается список площадок погрузки и выгрузки пользователя.

get

/gw/timeslots/api/v1/terminal

CURL

Копировать

Пример ответа

Ответ

200 Возвращаются площадки погрузки-выгрузки

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":{...}

"count":2,

"terminals":[...]

{...},

"id":35260,

"gates":[],

"schedule":[...],

{...},

"day_of_week":"1",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...},

"day_of_week":"2",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...},

"day_of_week":"3",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...},

"day_of_week":"4",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...},

"day_of_week":"5",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...},

"day_of_week":"6",

"time_from":"00:00:00",

"time_to":"23:59:00"

{...}

"day_of_week":"7",

"time_from":"00:00:00",

"time_to":"23:59:00"

}

"contacts":[...],

{...}

"id":35496,

"name":"Имя менеджера склада",

"phone":"+7 000 000-00-00",

"country_phone_id":"0"

}

"name":"Площадка",

"gates_count":1,

"loading_type":"any",

"date_creation":"2023-07-04T07:45:11.954912+03:00",

"date_modified":"2023-07-04T07:45:11.954929+03:00",

"deleted":false,

"is_test":false,

"warehouse":34824

{...}

"id":35259,

"gates":[],

"schedule":[],

"contacts":[],

"name":"Площадка",

"gates_count":1,

"loading_type":"any",

"date_creation":"2023-07-04T06:57:45.340826+03:00",

"date_modified":"2023-07-04T07:34:58.968527+03:00",

"deleted":true,

"is_test":false,

"warehouse":34823

}

]

}

{...}

ok: boolean

result:{...}

count: integer

terminals:[{...}]

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

id: integer

Идентификатор площадки погрузки-выгрузки

gates:[{}]

Список ворот площадки погрузки-выгрузки

schedule*:[{...}]

Расписание работы площадки погрузки-выгрузки

time_from*: string

Время начала работы склада

time_to*: string

Время окончания работы склада

day_of_week*: integer

>=1 and <= 7

Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.

}]

contacts*:[{...}]

Контактные данные ответственных лиц

id: integer

Идентификатор контакта во временных окнах

name*: string

Имя контактного лица

phone*: string

Телефон контактного лица

country_phone_id*: integer

>=0 and <= 4

Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие

}]

name*: string

Название площадки погрузки-выгрузки

gates_count*: integer

Количество ворот

loading_type*: enum

[any, gates, up, lateral]

Тип загрузки

date_creation: string

Дата создания площадки погрузки-выгрузки

date_modified: string

Дата изменения площадки погрузки-выгрузки

deleted: boolean

Флаг, указывающий существует ли площадка погрузки-выгрузки или была удалена

is_test: boolean

Флаг, указывающий является ли площадка погрузки-выгрузки тестовой

warehouse*: integer

Идентификатор склада

}]

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

Удаление площадок погрузки-выгрузки

delete

/gw/timeslots/api/v1/terminal

Развернуть все Свернуть все

body

object

{...}

terminal_ids*: [integer]

Список удаляемых площадок погрузки-выгрузки

}

CURL

Копировать

Пример ответа

Ответ

200 Возвращается список удаленных площадок погрузки-выгрузки, а также списки ошибок, если таковые возникли

Развернуть все Свернуть все

Пример

Модель

{...}

"ok":true,

"result":{...}

"200":[...],

35262

"400":[],

"500":[]

}

{...}

ok: boolean

result:{...}

200: [integer]

Список идентификаторов удаленных площадок погрузки-выгрузки

400: [integer]

Список идентификаторов складов, при удалении которых возникли ошибки валидации

500: [integer]

Список идентификаторов складов, при удалении которых возникли ошибки сервера

}

400 Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"bad request",

"reason":"Необходимо передать список terminal_ids",

"details":null

}

{...}

Одиночная ошибка

error: string

Текстовый код ошибки

reason: string

Человекочитаемый текст ошибки

}

Загрузка...

Развернуть все Свернуть все

Загрузка...