MaintenanceRequest

Gets all maintenance request or filtered by Equipment Code.

For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
query Parameters
equipmentCode
string or null

Optionally filter maintenance requests by Equipment Code

businessUnitId
string <uuid>

Optionally filter maintenance requests by Business Unit Id

businessUnitCode
string or null

Optionally filter maintenance requests by Business Unit Code

changesSinceDate
string or null

Optionally filter to maintenance requests that are either new or have changed since the specified date.

count
integer or null <int32>

The total number of records to return. Default: 100. Limit: 1000.

cursor
integer or null <int32>

The point at which to start pagination. Returned as "next" or "prev" in the response. Default: 1.

Responses
200

Success

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.

get/api/v1/maintenanceRequest
Request samples 
Response samples 
application/json
{
  • "count": 2,
  • "prev": 4,
  • "next": 8,
  • "timestamp": 1594300743,
  • "data": [
    ]
}
Creates a new maintenance request.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
description
required
string
Description of the Maintenance Request


 
equipmentCode
string or null
The unique equipment code (required if there is no equipment id)


 
equipmentId
string or null <uuid> 
The equipment id (required if there is no equipment code)


 
jobId
string or null <uuid> 
(optional) Job Id


 
jobCode
string or null
(optional) Job Code(will use job code only if job id is not provided).


 
priorityId
string or null <uuid> 
(optional) Priority Id


 
pointOfContactName
string or null
(optional) Point of contact name


 
pointOfContactPhoneNumber
string or null
(optional) Point of contact phone number


 
source
required
string
Client app submitting the maintenance request


 
requestedBy
string or null
Person that made the request


 
Array of objects or null (AttachmentCreate) 
Photo attachments (maximum of 3 files, 10MB each)


 
Responses 
200
Success


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


404
Endpoint Not Found. This response may occur if the on-premises E360 service does not exist or is not currently running.


post/api/v1/maintenanceRequest
Request samples 
{
  • "description": "equipment won't start",
  • "equipmentCode": "DZR-01",
  • "equipmentId": "f0b41e63-5ce5-41ff-a934-497da0c599bc",
  • "jobId": "b1277067-64cd-42d4-9283-cb316eca7e59",
  • "jobCode": "SW Freeway",
  • "priorityId": "3d47353b-8473-469a-9f58-822c527a29da",
  • "pointOfContactName": "John Watson",
  • "pointOfContactPhoneNumber": "123-456-7890",
  • "source": "E360 API",
  • "requestedBy": "John Watson",
  • "attachments": [
    ]
}
Response samples 
application/json
{
  • "id": "94a4f6d3-1679-40ab-ba58-94c80a32056a",
  • "requestedDate": "2019-01-21T00:00:00",
  • "priorityCode": "Low",
  • "status": "Added to work order",
  • "statusDate": "2019-01-21T00:00:00",
  • "workOrderId": 55,
  • "workOrderStatusCode": "Open",
  • "workOrderStatusChangedBy": "Will Smith",
  • "workOrderStatusDate": "2019-01-21T00:00:00",
  • "pointOfContact": "Jimmy John 281-123-4567",
  • "dismissedDescription": "",
  • "description": "It's broken",
  • "equipmentCode": "01-100",
  • "equipmentId": "69bd8de3-3d74-49a5-9965-421a2752d5e1",
  • "jobId": "9d16be7a-4dc7-47dd-9ee1-fed7a4d5b970",
  • "jobCode": "West Street",
  • "priorityId": "dc956f98-3d46-4085-ae57-090c2bb838ee",
  • "source": "Heavy Job",
  • "requestedBy": "Ricky Bobby"
}