workorder-api (1.0)

Download OpenAPI specification:Download

workorders

The Workorders API

Get Workorder by ID

Retrieve the information of the workorder with the matching workorder ID.

SecurityApiKeyAuth
Request
path Parameters
id
required
string

The ID number of the object being returned

Example: 2378'
Responses
200

Ok

get/{id}
Request samples 
Response samples 
application/json
{
  • "id": "6XLeG3x91pQlBWjnXvARYO2onNVM0q",
  • "publicId": 2381,
  • "workOrderSettingsId": "O8MqwQ1X3L5RyaxVLBnNK2lGxerYAz",
  • "reference": "Trucker LLC",
  • "status": "sent",
  • "companyId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "userId": "AVeGYqb0d7MJpaDZxB69rlxDOZ8Nmo",
  • "signedCarrierName": "Jimbo",
  • "signedContactName": "Jimbo",
  • "signedDriverName": "Jimbo",
  • "signedDriverEmail": "jimbo@gmail.com",
  • "signedDriverPhone": "4045194104",
  • "signedContactEmail": "jimbo@gmail.com",
  • "signedContactPhone": "4045194104",
  • "signedCustomFields": {
    },
  • "createdAt": "2023-11-14T16:27:56.419546Z",
  • "updatedAt": "2023-11-14T16:27:56.419546Z",
  • "invoiceId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "invoiceStatus": "completed",
  • "location": {
    }
}
Delete workorders by ID
Deletes the workorder with a specific ID.


SecurityApiKeyAuth 
Request 
path Parameters
id
required
string
The ID number of the object being returned


 
 Example:  2378
Responses 
200
OK


403
Forbidden


404
Not Found


delete/{id}
Request samples 
Get All Recent Workorders
Retrieve 20 Most Recent Workorders.


SecurityApiKeyAuth 
Responses 
200
Ok


get/
Request samples 
Response samples 
application/json
{
  • "id": "6XLeG3x91pQlBWjnXvARYO2onNVM0q",
  • "publicId": 2381,
  • "workOrderSettingsId": "O8MqwQ1X3L5RyaxVLBnNK2lGxerYAz",
  • "reference": "Trucker LLC",
  • "status": "sent",
  • "companyId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "userId": "AVeGYqb0d7MJpaDZxB69rlxDOZ8Nmo",
  • "signedCarrierName": "Jimbo",
  • "signedContactName": "Jimbo",
  • "signedDriverName": "Jimbo",
  • "signedDriverEmail": "jimbo@gmail.com",
  • "signedDriverPhone": "4045194104",
  • "signedContactEmail": "jimbo@gmail.com",
  • "signedContactPhone": "4045194104",
  • "signedCustomFields": {
    },
  • "createdAt": "2023-11-14T16:27:56.419546Z",
  • "updatedAt": "2023-11-14T16:27:56.419546Z",
  • "invoiceId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "invoiceStatus": "completed",
  • "location": {
    }
}
Create New Workorder
Create a new workorder.


SecurityApiKeyAuth 
Request 
Request Body schema: application/json
Post the necessary fields for the API to create a new workorder.


id
string (id) 
The id number of the object being returned.


 
publicId
integer (publicId) 
The Roadsync Public ID of the workorder


 
workOrderSettingsId
string (workOrderSettingsId) 
Hashed ID for the workorder settings


 
reference
string (reference) 
Workorder reference for record keeping purposes


 
status
any (status) 
Enum containing the possible workorder status


 Enum: "unknown" "new" "sent" "completed"  
companyId
string (companyId) 
Hashed company ID attached to each workorder


 
userId
string (userId) 
ID of the user creating workorders


 
signedCarrierName
string (signedCarrierName) 
Name of carrier who signed workorder


 
signedContactName
string (signedContactName) 
Name of the contact signing the workorder


 
signedDriverName
string (signedDriverName) 
Name of driver who signed the workorder


 
signedDriverEmail
string (signedDriverEmail) 
Email of driver who signed the workorder


 
signedDriverPhone
string (signedDriverPhone) 
Phone number of driver who signed the workorder


 
signedContactEmail
string (signedContactEmail) 
Email of the contact signing the workorder


 
signedContactPhone
string (signedContactPhone) 
Phone number of the contact signing the workorder


 
object
 
createdAt
string <date-time>  (createdAt) 
Created at value for workorder


 
updatedAt
string <date-time>  (updatedAt) 
Updated at value for workorder


 
invoiceId
string (invoiceId) 
Hashed invoice ID for the workorder


 
invoiceStatus
string (invoiceStatus) 
Status of invoice attached to workorder


 
object (location) 
Location for the workorder


 
Responses 
200
Created


400
Bad Request


409
Conflict


post/
Request samples 
application/json
{
  • "id": "6XLeG3x91pQlBWjnXvARYO2onNVM0q",
  • "publicId": 2381,
  • "workOrderSettingsId": "O8MqwQ1X3L5RyaxVLBnNK2lGxerYAz",
  • "reference": "Trucker LLC",
  • "status": "sent",
  • "companyId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "userId": "AVeGYqb0d7MJpaDZxB69rlxDOZ8Nmo",
  • "signedCarrierName": "Jimbo",
  • "signedContactName": "Jimbo",
  • "signedDriverName": "Jimbo",
  • "signedDriverEmail": "jimbo@gmail.com",
  • "signedDriverPhone": "4045194104",
  • "signedContactEmail": "jimbo@gmail.com",
  • "signedContactPhone": "4045194104",
  • "signedCustomFields": {
    },
  • "createdAt": "2023-11-14T16:27:56.419546Z",
  • "updatedAt": "2023-11-14T16:27:56.419546Z",
  • "invoiceId": "rZNz3VwGoJDMEaok3aQY7dqWRAL4y8",
  • "invoiceStatus": "completed",
  • "location": {
    }
}
Response samples 
application/json
{ }
Send workorder
Send a workorder to a recipient via email or text.


SecurityApiKeyAuth 
Request 
path Parameters
id
required
string
 
Request Body schema: application/json
Any of:
string (email) 
 
Responses 
200
OK


post/{id}/send
Request samples 
application/json
"user@example.com"
Approve Workorders
SecurityApiKeyAuth 
Request 
path Parameters
id
required
string
 
Request Body schema: application/json
signedCarrierName
string (signedCarrierName) 
Name of carrier who signed workorder


 
signedContactPhone
string (signedContactPhone) 
Phone number of the contact signing the workorder


 
signedCustomFields
string (signedCustomFields) 
Signed custom fields for workorders


 
signedDriverName
string (signedDriverName) 
Name of driver who signed the workorder


 
signedDriverPhone
string (signedDriverPhone) 
Phone number of driver who signed the workorder


 
signedFileId
string (signedFileId) 
 
Responses 
200
OK


post/{id}/approve
Request samples 
application/json
{
  • "signedCarrierName": "Jimbo",
  • "signedContactPhone": "4045194104",
  • "signedCustomFields": "string",
  • "signedDriverName": "Jimbo",
  • "signedDriverPhone": "4045194104",
  • "signedFileId": "string"
}
Copyright © RoadSync 2023. All right reserved.