Skip to main content
POST
/
job
/
create
Create Job
curl --request POST \
  --url https://ontime-api.masternautconnect.com/jobs/job/create \
  --header 'Content-Type: application/json' \
  --header 'x-connect-token: <x-connect-token>' \
  --data '
{
  "jobId": "<string>",
  "jobNumber": "<string>",
  "jobTitle": "<string>",
  "clientName": "<string>",
  "accountNumber": "<string>",
  "contactName": "<string>",
  "contactEmail": "<string>",
  "contactPhone": "<string>",
  "notes": "<string>",
  "lat": 123,
  "lng": 123,
  "address": "<string>",
  "statusChangeTimestamp": "<string>",
  "statusChangeId": "<string>",
  "scheduledStartDateTime": "<string>",
  "jobDuration": "<string>",
  "arrivalWindowStart": "<string>",
  "arrivalWindowEnd": "<string>",
  "personId": "<string>",
  "vehicleId": "<string>",
  "groupName": "<string>",
  "personName": "<string>",
  "vehicleName": "<string>",
  "orderNumbers": [
    "<string>"
  ],
  "status": "NEW",
  "driverNotes": "<string>",
  "statusHistory": [
    {
      "date": "<string>",
      "personId": "<string>",
      "name": "<string>",
      "status": "NEW",
      "statusChangeId": "<string>"
    }
  ],
  "actualStart": "<string>",
  "actualEnd": "<string>",
  "overrideLat": 123,
  "overrideLng": 123,
  "jobHistory": [
    {
      "date": "<string>",
      "personId": "<string>",
      "name": "<string>",
      "assignedPersonName": "<string>",
      "assignedAssetName": "<string>"
    }
  ],
  "jobRadius": 123,
  "eta": "<string>",
  "etaDistanceKms": 123,
  "lastEtaCalcTime": "<string>",
  "primaryResource": "DRIVER",
  "jobTypeId": "<string>",
  "jobType": {
    "id": "<string>",
    "label": "<string>",
    "description": "<string>",
    "global": true,
    "used": true,
    "disabled": true,
    "key": "<string>",
    "earliestStartTime": 123,
    "latestStartTime": 123,
    "duration": "<string>",
    "notes": "<string>",
    "resources": [
      {
        "name": "<string>",
        "status": "NONE",
        "fileType": "<string>",
        "storageUrl": "<string>",
        "uploadUrl": "<string>",
        "presignedGetUrl": "<string>"
      }
    ],
    "sendJobReportOnCompletion": true,
    "workflowId": "<string>"
  },
  "jobPhotos": [
    {
      "date": "<string>",
      "downloadUrl": "<string>"
    }
  ],
  "jobSignature": {
    "date": "<string>",
    "downloadUrl": "<string>",
    "signeeName": "<string>"
  },
  "linkingId": "<string>",
  "linkedJobDescription": "<string>",
  "linkedJobIndex": "<string>",
  "resources": [
    {
      "name": "<string>",
      "status": "NONE",
      "fileType": "<string>",
      "storageUrl": "<string>",
      "uploadUrl": "<string>",
      "presignedGetUrl": "<string>"
    }
  ],
  "subStatus": {
    "key": "<string>",
    "value": "<string>"
  },
  "lastServerTime": "<string>",
  "visitResults": [
    {
      "jobScheduledStart": "<string>",
      "taskAnswers": [
        {
          "title": "<string>",
          "description": "<string>",
          "key": "<string>",
          "statusChangeId": "<string>",
          "timestamp": "<string>",
          "nextTaskKey": "<string>",
          "taskHandler": "TEXT_INFO_DISPLAY",
          "onTransitionTo": "<string>",
          "mandatory": true,
          "includeInReport": true,
          "value": {
            "stringValues": [
              "<string>"
            ],
            "integerValue": 123,
            "doubleValue": 123,
            "blobValues": [
              "<string>"
            ]
          },
          "onTransitionToLabel": "<string>",
          "personId": "<string>",
          "personName": "<string>"
        }
      ]
    }
  ],
  "subStatusLabel": "<string>",
  "statusLabel": "<string>"
}
'
{
  "job": {
    "jobId": "<string>",
    "jobNumber": "<string>",
    "jobTitle": "<string>",
    "clientName": "<string>",
    "accountNumber": "<string>",
    "contactName": "<string>",
    "contactEmail": "<string>",
    "contactPhone": "<string>",
    "notes": "<string>",
    "lat": 123,
    "lng": 123,
    "address": "<string>",
    "statusChangeTimestamp": "<string>",
    "statusChangeId": "<string>",
    "scheduledStartDateTime": "<string>",
    "jobDuration": "<string>",
    "arrivalWindowStart": "<string>",
    "arrivalWindowEnd": "<string>",
    "personId": "<string>",
    "vehicleId": "<string>",
    "groupName": "<string>",
    "personName": "<string>",
    "vehicleName": "<string>",
    "orderNumbers": [
      "<string>"
    ],
    "status": "NEW",
    "driverNotes": "<string>",
    "statusHistory": [
      {
        "date": "<string>",
        "personId": "<string>",
        "name": "<string>",
        "status": "NEW",
        "statusChangeId": "<string>"
      }
    ],
    "actualStart": "<string>",
    "actualEnd": "<string>",
    "overrideLat": 123,
    "overrideLng": 123,
    "jobHistory": [
      {
        "date": "<string>",
        "personId": "<string>",
        "name": "<string>",
        "assignedPersonName": "<string>",
        "assignedAssetName": "<string>"
      }
    ],
    "jobRadius": 123,
    "eta": "<string>",
    "etaDistanceKms": 123,
    "lastEtaCalcTime": "<string>",
    "primaryResource": "DRIVER",
    "jobTypeId": "<string>",
    "jobType": {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "global": true,
      "used": true,
      "disabled": true,
      "key": "<string>",
      "earliestStartTime": 123,
      "latestStartTime": 123,
      "duration": "<string>",
      "notes": "<string>",
      "resources": [
        {
          "name": "<string>",
          "status": "NONE",
          "fileType": "<string>",
          "storageUrl": "<string>",
          "uploadUrl": "<string>",
          "presignedGetUrl": "<string>"
        }
      ],
      "sendJobReportOnCompletion": true,
      "workflowId": "<string>"
    },
    "jobPhotos": [
      {
        "date": "<string>",
        "downloadUrl": "<string>"
      }
    ],
    "jobSignature": {
      "date": "<string>",
      "downloadUrl": "<string>",
      "signeeName": "<string>"
    },
    "linkingId": "<string>",
    "linkedJobDescription": "<string>",
    "linkedJobIndex": "<string>",
    "resources": [
      {
        "name": "<string>",
        "status": "NONE",
        "fileType": "<string>",
        "storageUrl": "<string>",
        "uploadUrl": "<string>",
        "presignedGetUrl": "<string>"
      }
    ],
    "subStatus": {
      "key": "<string>",
      "value": "<string>"
    },
    "lastServerTime": "<string>",
    "visitResults": [
      {
        "jobScheduledStart": "<string>",
        "taskAnswers": [
          {
            "title": "<string>",
            "description": "<string>",
            "key": "<string>",
            "statusChangeId": "<string>",
            "timestamp": "<string>",
            "nextTaskKey": "<string>",
            "taskHandler": "TEXT_INFO_DISPLAY",
            "onTransitionTo": "<string>",
            "mandatory": true,
            "includeInReport": true,
            "value": {
              "stringValues": [
                "<string>"
              ],
              "integerValue": 123,
              "doubleValue": 123,
              "blobValues": [
                "<string>"
              ]
            },
            "onTransitionToLabel": "<string>",
            "personId": "<string>",
            "personName": "<string>"
          }
        ]
      }
    ],
    "subStatusLabel": "<string>",
    "statusLabel": "<string>"
  },
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "csvUploadLink": "<string>"
}

Headers

​
x-connect-token
string
required

Specifies the MyConnectedFleet platform type as token. Set the value for the token to be the response from calling the Request OAuth Token endpoint.

Query Parameters

​
override
boolean | null
default:true

Specifies that the HTTP body type to be JSON and that the character set is in UTF-8.

Body

application/json
​
jobId
string

System identifier for the job.

​
jobNumber
string

Number for the job. If provided must be unique, If not provided then a job number will be generated.

​
jobTitle
string

Title for the job.

​
clientName
string

The account’s customer’s name.

​
accountNumber
string
​
contactName
string

Name of the contact person to receive the order.

​
contactEmail
string

Email address for the named contact.

​
contactPhone
string

Phone number for the named contact.

​
notes
string

Notes for the job.

​
lat
number<double>

Latitude value for the delivery location. Must be specified if a value for address is not specified. If specified, then a value for lng must also be specified.

​
lng
number<double>

Longitude value for the delivery location. Must be specified if a value for address is not specified. If specified, then a value for lat must also be specified.

​
address
string

Full job address. Must be specified if values for lng and lat are not specified. If specified, then values latitude and longitude are derived. If not specified, then will be derived based on the values specified for lng and lat

​
statusChangeTimestamp
string
​
statusChangeId
string
​
scheduledStartDateTime
string

Scheduled date & time for fulfilment of the job, in UTC, and formatted as either YYYY-MM-DDTHH:mmZ or YYYY-DD-MM.

​
jobDuration
string

Scheduled duration for the job in hours and minutes.

​
arrivalWindowStart
string

The start of the arrival window, in UTC, and formatted as YYYY-MM-DDTHH:mmZ.

​
arrivalWindowEnd
string

The end of the arrival window, in UTC, and formatted as YYYY-MM-DDTHH:mmZ.

​
personId
string

System identifier for an existing driver. If specified then personName will be set to the name of the specified driver.

​
vehicleId
string

System identifier for an existing vehicle. If specified then vehicleName will be set to the name of the specified driver.

​
groupName
string

Name of an existing group. If not specified, then will default to the root group in the hierarchy.

​
personName
string
​
vehicleName
string

Name of an existing vehicle. If specified then personName will be set to the default driver for the vehicle. If values for both personName and vehicleName have been set then personName must be the default driver that has been set for the specified vehicleName. personName can be any driver if there is no default driver for the specified vehicleName.

​
orderNumbers
string[]

Comma separated list of order numbers.

​
status
enum<string>

Status of the job. Allowed values are: [NEW, ASSIGNED, IN_PROGRESS, VISITED, CANCELLED].

Available options:
NEW,
ASSIGNED,
RECEIVED,
IN_PROGRESS,
VISITED,
CANCELLED,
MISSED,
ACCEPTED,
INCOMPLETE,
$UNKNOWN
​
driverNotes
string
​
statusHistory
object[]
​
actualStart
string
​
actualEnd
string
​
overrideLat
number<double>
​
overrideLng
number<double>
​
jobHistory
object[]
​
jobRadius
integer<int32>

Default value is set to 200 metres where no radius is specified. This can be modified using the jobRadius parameter.

​
eta
string
​
etaDistanceKms
number<double>
​
lastEtaCalcTime
string
​
primaryResource
enum<string>

Denotes whether the vehicle is assigned to a vehicle or driver

Available options:
DRIVER,
VEHICLE,
$UNKNOWN
​
jobTypeId
string

Unique, unchangeable system generated identifier (alphanumeric) of an existing job type to be assigned to this job.

​
jobType
object
​
jobPhotos
object[]
​
jobSignature
object
​
linkingId
string

Unique identifier (alphanumeric) for creating a linking job. Either linkingId or linkedJobIndex can be specified. If linkingId is specified as an empty string, then a value will be automatically generated.

​
linkedJobDescription
string

Description for linking job.

​
linkedJobIndex
string

Sequence number for creating a linking job. Either linkingId or linkedJobIndex can be specified.

​
resources
object[]

The names of the files you would like to upload to the job (max 3)

​
subStatus
object
​
lastServerTime
string
​
visitResults
object[]
​
subStatusLabel
string
​
statusLabel
string

Response

200 - application/json

createJob 200 response

​
job
object
​
errors
object[]
​
csvUploadLink
string