/jobs

POST

/jobs

Create new job for applicable drivers and vehicles

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

token

string

required

Body Params application/json

name

string

required

Name of the job that uniquely identifies the job

>= 1 characters<= 100 characters

description

string

optional

Detailed description of the job

>= 0 characters<= 4000 characters

location

string

optional

Address of the job

>= 0 characters<= 2000 characters

effectiveDateRange

object

required

startDate

string <date>

required

Period start date in format yyyy-mm-dd

endDate

string <date>

required

Period end date in format yyyy-mm-dd

drivers

array[string]

required

List of driver IDs applicable for this job

devices

array[string]

required

List of device IDs applicable for this job

customerInfo

object

optional

name

string

optional

Customer name

<= 100 characters

string

optional

Customer email address

<= 50 characters

phone

string

optional

Customer phone number

<= 20 characters

reportRequired

boolean

optional

signatureRequired

boolean

optional

photoRequired

boolean

optional

notes

string

optional

Additional notes for the job

<= 4000 characters

Example

{
    "name": "string",
    "description": "string",
    "location": "string",
    "effectiveDateRange": {
        "startDate": "2019-08-24",
        "endDate": "2019-08-24"
    },
    "drivers": [
        "string"
    ],
    "devices": [
        "string"
    ],
    "customerInfo": {
        "name": "string",
        "email": "string",
        "phone": "string"
    },
    "reportRequired": true,
    "signatureRequired": true,
    "photoRequired": true,
    "notes": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/jobs' \
--header 'token;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "name": "string",
    "description": "string",
    "location": "string",
    "effectiveDateRange": {
        "startDate": "2019-08-24",
        "endDate": "2019-08-24"
    },
    "drivers": [
        "string"
    ],
    "devices": [
        "string"
    ],
    "customerInfo": {
        "name": "string",
        "email": "string",
        "phone": "string"
    },
    "reportRequired": true,
    "signatureRequired": true,
    "photoRequired": true,
    "notes": "string"
}'

Responses

🟢200成功

application/json

200 response

Body

status

number

optional

response status (http status)

data

number

optional

ID of the newly created job

Example

{
    "status": 0,
    "data": 0
}

🟠400请求有误

Modified at 2025-02-28 08:12:14

Retrieve geofence alerts

Retrieve All Devices from an Enterprise