API Reference

Creates a set of missions.

post
https://scheduled-trips.api.eu1.scalar.zf.com/v1/missions

Creates a set of missions with at least one mission and one action:

-A set of missions requires at least one driver or asset.

Body Params
string | null

Represents the external ID of this mission set.

cargoLoadCarrierIds
array of uuids
length ≤ 5

Represents the load carriers used in this mission.

cargoLoadCarrierIds
uuid | null

The assetId refers to the truck being driven on this mission set. NOTE: You must define at least one truck or one driver per mission set.

uuid | null

The driverId refers to the driver driving this mission set. NOTE: You must define at least one driver or one truck per mission set.

missions
array of objects
length between 1 and 100

Represents missions.

missions
string
length ≤ 100

Represents the name of this mission.

string | null

Provides additional details added for the driver.

date-time | null

Execution time is optional. We'll set it to the current time if it's not filled in.

uuid | null

Represents the ID of the place where this mission should be executed. Either a Place or a PlaceId must be provided.

uuid | null

Represents the optional route that a driver has to take to get to his destination.

place
object

These fields are optional so nullable, They're either excluded or set to null.

string | null

Represents the external ID of this mission.

appLinks
array of objects
length ≤ 10

Optional links that can be provided for the driver. Example: add a phone number.

appLinks
actions
array of objects
length between 1 and 250

A list of actions that must be executed within this mission.

actions
string | null

Provides additional details added for the driver.

uuid
required

Represents the ID of the activity definition that should be executed.

workflowConfiguration
object | null

Represents the workflow configuration for this order. By using this you can pre-set some values for the drivers workflow.

string | null

Represents the external ID of this action.

appLinks
array of objects
length ≤ 10

Optional links that can be provided for the driver. Example: add a phone number.

appLinks
orders
array of objects | null

Represents the orders that are part of this action.

orders
Responses

401

Failure code. Unauthorized access.

Updated about 4 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 4 hours ago

Did this page help you?