Transfers

Departs from an arrived waypoint towards the next stop.

Requires ManageTransfers and an Idempotency-Key header; no body. The waypoint must be Arrived; it becomes Departed and the transfer InTransitToWaypoint (heading to the next waypoint, currentWaypointId) or InTransitToDestination. Same transfer rule as …/arrive.

post/api/v1/transfers/{id}/waypoints/{waypointId}/depart

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/transfers/{id}/waypoints/{waypointId}/depart
  • Auth: HTTP bearer

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

waypointIdinteger required

Waypoint id (waypoints[].id).

Response

Transfer id and confirmation (Waypoint status updated to Departed).

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

No recorded changes to this operation across all 1 revision of this API.