Shifts

OpenAPI Specification

• shifts
  • getGetting a list of shifts
  • postCreating a shift
  • delDeleting a shift
  • getGetting a shift
  • putUpdating a shift
  • getGetting shift assignments
  • postUpdating shift assignments

API docs by Redocly

Public API (0.0.0)

2GIS GeoFlow Public API

shifts

Getting a list of shifts

Returns a page with a list of shifts for the specified period.

Authorizations:

BearerAuth

query Parameters

limit required	integer Maximum number of shifts in the response, from 1 to 100.
cursor	string Cursor for getting the next or previous page of results.
from required	string Date and time of period start in RFC 3339 format.
to required	string Date and time of period end in RFC 3339 format.

Responses

Response Schema: application/json

required	object (CursorResponse) Cursors for the next and previous result pages.
required	Array of objects (ShiftResponse) Current page items.

Server 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"

    }

  ]

}

Creating a shift

Creates a shift.

Authorizations:

BearerAuth

Request Body schema: application/json

required

Data for creating a shift.

end_at	string <date-time> Date and time of shift end in RFC 3339 format.
full_day	boolean Flag indicating that the shift lasts 24 hours.
name required	string Shift name.
start_at	string <date-time> Date and time of shift start in RFC 3339 format.
timezone required	string Time zone in IANA format (for example, Europe/Moscow).

Responses

Response Schema: application/json

created_at required	string <date-time> Date and time of shift creation in RFC 3339 format.
end_at	string <date-time> Date and time of shift end in RFC 3339 format.
full_day required	boolean Flag indicating that the shift lasts 24 hours.
id required	string <uuid> Shift identifier.
name required	string Shift name.
start_at	string <date-time> Date and time of shift start in RFC 3339 format.
timezone required	string Time zone in IANA format (for example, Europe/Moscow).
updated_at required	string <date-time> Date and time of the shift last update in RFC 3339 format.

Server 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"

}

Deleting a shift

Deletes a shift by its identifier.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Shift identifier.

Responses

Server 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"

      }

    }

  ]

}

Getting a shift

Returns shift data by its identifier.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Shift identifier.

Responses

Response Schema: application/json

created_at required	string <date-time> Date and time of shift creation in RFC 3339 format.
end_at	string <date-time> Date and time of shift end in RFC 3339 format.
full_day required	boolean Flag indicating that the shift lasts 24 hours.
id required	string <uuid> Shift identifier.
name required	string Shift name.
start_at	string <date-time> Date and time of shift start in RFC 3339 format.
timezone required	string Time zone in IANA format (for example, Europe/Moscow).
updated_at required	string <date-time> Date and time of the shift last update in RFC 3339 format.

Server 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"

}

Updating a shift

Updates shift data by its identifier.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Shift identifier.

Request Body schema: application/json

required

New values of shift attributes.

end_at	string <date-time> Date and time of shift end in RFC 3339 format.
full_day	boolean Flag indicating that the shift lasts 24 hours.
name required	string Shift name.
start_at	string <date-time> Date and time of shift start in RFC 3339 format.
timezone required	string Time zone in IANA format (for example, Europe/Moscow).

Responses

Response Schema: application/json

created_at required	string <date-time> Date and time of shift creation in RFC 3339 format.
end_at	string <date-time> Date and time of shift end in RFC 3339 format.
full_day required	boolean Flag indicating that the shift lasts 24 hours.
id required	string <uuid> Shift identifier.
name required	string Shift name.
start_at	string <date-time> Date and time of shift start in RFC 3339 format.
timezone required	string Time zone in IANA format (for example, Europe/Moscow).
updated_at required	string <date-time> Date and time of the shift last update in RFC 3339 format.

Server 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"

}

Getting shift assignments

Returns a list of agents added to the shift and a list of shift tasks with assigned agents.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Shift identifier.

Responses

Response Schema: application/json

	Array of objects (ShiftAgentAssignmentResponse) Agent assignments to the shift.
shift_id required	string <uuid> Shift identifier.
	Array of objects (ShiftTaskAssignmentResponse) Task assignments.

Server 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"

    }

  ]

}

Updating shift assignments

Updates the list of agents added to the shift and the list of shift tasks with assigned agents.

Authorizations:

BearerAuth

path Parameters

id required

string <uuid> Shift identifier.

Request Body schema: application/json

required

New list of agents and shift tasks with assignments.

agent_ids	Array of strings unique Agent identifiers.
	Array of objects (ShiftTaskAssignmentInput) unique Task assignments.

Responses

Response Schema: application/json

	Array of objects (ShiftAgentAssignmentResponse) Agent assignments to the shift.
shift_id required	string <uuid> Shift identifier.
	Array of objects (ShiftTaskAssignmentResponse) Task assignments.

Server 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"

    }

  ]

}