Смены

Спецификация OpenAPI

• shifts
  • getПолучение списка смен
  • postСоздание смены
  • delУдаление смены
  • getПолучение смены
  • putОбновление смены
  • getПолучение назначений смены
  • postОбновление назначений смены

API docs by Redocly

Публичный API (0.0.0)

Публичный API 2ГИС ГеоПоток

shifts

Получение списка смен

Возвращает страницу со списком смен за заданный период.

Authorizations:

BearerAuth

query Parameters

limit required	integer Максимальное число смен в ответе, от 1 до 100.
cursor	string Курсор для получения следующей или предыдущей страницы результатов.
from required	string Дата и время начала периода в формате RFC 3339.
to required	string Дата и время окончания периода в формате RFC 3339.

Responses

Response Schema: application/json

required	object (CursorResponse) Курсоры следующей и предыдущей страниц результата.
required	Array of objects (ShiftResponse) Элементы текущей страницы.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "cursor": {

  • "next": "string",
  • "prev": "string"

  },
• "items": [

  • {

    • "created_at": "2019-08-24T14:15:22Z",
    • "end_at": "2019-08-24T14:15:22Z",
    • "full_day": true,
    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "start_at": "2019-08-24T14:15:22Z",
    • "timezone": "string",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Создание смены

Создаёт смену.

Authorizations:

BearerAuth

Request Body schema: application/json

required

Данные для создания смены.

end_at	string <date-time> Дата и время окончания смены в формате RFC 3339.
full_day	boolean Признак, что смена продолжается сутки.
name required	string Название смены.
start_at	string <date-time> Дата и время начала смены в формате RFC 3339.
timezone required	string Часовой пояс в формате IANA (например, Europe/Moscow).

Responses

Response Schema: application/json

created_at required	string <date-time> Дата и время создания смены в формате RFC 3339.
end_at	string <date-time> Дата и время окончания смены в формате RFC 3339.
full_day required	boolean Признак, что смена продолжается сутки.
id required	string <uuid> Идентификатор смены.
name required	string Название смены.
start_at	string <date-time> Дата и время начала смены в формате RFC 3339.
timezone required	string Часовой пояс в формате IANA (например, Europe/Moscow).
updated_at required	string <date-time> Дата и время последнего обновления смены в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts

Request samples

• Payload

Content type

application/json

{

• "end_at": "2019-08-24T14:15:22Z",
• "full_day": true,
• "name": "string",
• "start_at": "2019-08-24T14:15:22Z",
• "timezone": "string"

}

Response samples

• 200
• 400
• 401
• 500

Content type

application/json

{

• "created_at": "2019-08-24T14:15:22Z",
• "end_at": "2019-08-24T14:15:22Z",
• "full_day": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "string",
• "start_at": "2019-08-24T14:15:22Z",
• "timezone": "string",
• "updated_at": "2019-08-24T14:15:22Z"

}

Удаление смены

Удаляет смену по её идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор смены.

Responses

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts/{id}

Response samples

• 400
• 401
• 404
• 500

Content type

application/json

{

• "error_code": "string",
• "message": "string",
• "metadata": {

  • "property1": "string",
  • "property2": "string"

  },
• "violations": [

  • {

    • "error_code": "string",
    • "field": "string",
    • "message": "string",
    • "metadata": {

      • "property1": "string",
      • "property2": "string"

      }

    }

  ]

}

Получение смены

Возвращает данные смены по её идентификатору.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор смены.

Responses

Response Schema: application/json

created_at required	string <date-time> Дата и время создания смены в формате RFC 3339.
end_at	string <date-time> Дата и время окончания смены в формате RFC 3339.
full_day required	boolean Признак, что смена продолжается сутки.
id required	string <uuid> Идентификатор смены.
name required	string Название смены.
start_at	string <date-time> Дата и время начала смены в формате RFC 3339.
timezone required	string Часовой пояс в формате IANA (например, Europe/Moscow).
updated_at required	string <date-time> Дата и время последнего обновления смены в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts/{id}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "created_at": "2019-08-24T14:15:22Z",
• "end_at": "2019-08-24T14:15:22Z",
• "full_day": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "string",
• "start_at": "2019-08-24T14:15:22Z",
• "timezone": "string",
• "updated_at": "2019-08-24T14:15:22Z"

}

Обновление смены

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

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор смены.

Request Body schema: application/json

required

Новые значения атрибутов смены.

end_at	string <date-time> Дата и время окончания смены в формате RFC 3339.
full_day	boolean Признак, что смена продолжается сутки.
name required	string Название смены.
start_at	string <date-time> Дата и время начала смены в формате RFC 3339.
timezone required	string Часовой пояс в формате IANA (например, Europe/Moscow).

Responses

Response Schema: application/json

created_at required	string <date-time> Дата и время создания смены в формате RFC 3339.
end_at	string <date-time> Дата и время окончания смены в формате RFC 3339.
full_day required	boolean Признак, что смена продолжается сутки.
id required	string <uuid> Идентификатор смены.
name required	string Название смены.
start_at	string <date-time> Дата и время начала смены в формате RFC 3339.
timezone required	string Часовой пояс в формате IANA (например, Europe/Moscow).
updated_at required	string <date-time> Дата и время последнего обновления смены в формате RFC 3339.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts/{id}

Request samples

• Payload

Content type

application/json

{

• "end_at": "2019-08-24T14:15:22Z",
• "full_day": true,
• "name": "string",
• "start_at": "2019-08-24T14:15:22Z",
• "timezone": "string"

}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "created_at": "2019-08-24T14:15:22Z",
• "end_at": "2019-08-24T14:15:22Z",
• "full_day": true,
• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "name": "string",
• "start_at": "2019-08-24T14:15:22Z",
• "timezone": "string",
• "updated_at": "2019-08-24T14:15:22Z"

}

Получение назначений смены

Возвращает список агентов, добавленных в смену, и список задач смены с назначенными агентами.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор смены.

Responses

Response Schema: application/json

	Array of objects (ShiftAgentAssignmentResponse) Назначения агентов на смену.
shift_id required	string <uuid> Идентификатор смены.
	Array of objects (ShiftTaskAssignmentResponse) Назначения задач.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts/{id}/assignments

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "agent_assignments": [

  • {

    • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978"

    }

  ],
• "shift_id": "f15914ca-a3fc-41f9-a948-5ac849d2a017",
• "task_assignments": [

  • {

    • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
    • "created_at": "2019-08-24T14:15:22Z",
    • "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}

Обновление назначений смены

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

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Идентификатор смены.

Request Body schema: application/json

required

Новый список агентов и задач смены с назначениями.

agent_ids	Array of strings unique Идентификаторы агентов.
	Array of objects (ShiftTaskAssignmentInput) unique Назначения задач.

Responses

Response Schema: application/json

	Array of objects (ShiftAgentAssignmentResponse) Назначения агентов на смену.
shift_id required	string <uuid> Идентификатор смены.
	Array of objects (ShiftTaskAssignmentResponse) Назначения задач.

URL сервера

https://geoflow.2gis.ru/public/api/v1/shifts/{id}/assignments

Request samples

• Payload

Content type

application/json

{

• "agent_ids": [

  • "string"

  ],
• "task_assignments": [

  • {

    • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
    • "task_id": "736fde4d-9029-4915-8189-01353d6982cb"

    }

  ]

}

Response samples

• 200
• 400
• 401
• 404
• 500

Content type

application/json

{

• "agent_assignments": [

  • {

    • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978"

    }

  ],
• "shift_id": "f15914ca-a3fc-41f9-a948-5ac849d2a017",
• "task_assignments": [

  • {

    • "agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
    • "created_at": "2019-08-24T14:15:22Z",
    • "task_id": "736fde4d-9029-4915-8189-01353d6982cb",
    • "updated_at": "2019-08-24T14:15:22Z"

    }

  ]

}