OS1 Services
...
Dispatch Service
Integrate with Dispatch

How to: Manage Job Type

2min

For information about prerequisites, see Integrate with Dispatch.

Create a Job Type

To create a Job Type, call the Create Job Type endpoint and pass the following members in the request body:

Member

Description

toState

One of the valid state codes: onboarding, active, deboarding, or inactive.

reasonCode

A valid reason code associated with the event. (optional)

data

Any additional information about the transition. (optional)

Your JSON request body should be similar to the following:

JSON


Retrieve existing Job Types

To retrieve the list of all the existing Job Types, call the Get all Job Types endpoint. If you want to retrieve details of a particular Job Type, call the Get Job Type endpoint and specify the jobTypeId in the path parameter.