Equipment

Returns all equipment.

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

Securitybearer
Request
query Parameters
businessUnitId
string <uuid>

Optionally filter the returned list of equipment by business unit

equipmentCode
string or null

Optionally filter the returned list of equipment by Code

accountingCode
string or null

Optionally filter the returned list of equipment by Accounting Code

status
string or null

Optionally filter the returned list of equipment by Status Code

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.

includeDeleted
boolean or null
Default: false

Determines if deleted equipment should appear in results. Defaults to false.

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/equipment
Request samples 
Response samples 
application/json
{
  • "count": 2,
  • "prev": 11,
  • "next": 15,
  • "timestamp": 1594300743,
  • "data": [
    ]
}
Create a new equipment record.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
Request Body schema: 
The details of the equipment to be created.


businessUnitId
required
string <uuid> 
The equipment's business unit guid.


 
code
required
string
The equipment's code.


 
equipmentType
string or null
The equipment's type name.


 
description
string or null
A description of the equipment.


 
accountingCode
string or null
Equipment Accounting Code


 
make
string or null
The equipment's make.


 
model
string or null
The equipment's model.


 
year
integer or null <int32> 
The equipment's year.


 
vin
string or null
The equipment's VIN.


 
serialNo
string or null
The equipment's serial number.


 
hourMeter
integer <int32> 
If initialized, the most recent hour reading.


 
hourMeterDate
string or null <date-time> 
If initialized, the most recent hour reading date.


 
odometer
integer <int32> 
If initialized, the most recent odometer reading .


 
odometerDate
string or null <date-time> 
If initialized, the most recent odometer reading date.


 
imageUrl
string or null
The full URL of the equipment's image at Equipment360's document storage endpoint. Can be retrieved with a valid HCSS Apps access token.


 
region
string or null
The equipment's current region.


 
division
string or null
The equipment's current division.


 
weight
number <double> 
The equipment's unloaded weight.


 
length
number <double> 
The equipment's length.


 
width
number <double> 
The equipment's length.


 
height
number <double> 
The equipment's height.


 
numberAxles
integer <int32> 
Number of axles on the equipment.


 
tireSize
string or null
Tire Size Front / Rear


 
status
string or null
Status


 
enabled
string or null
Enabled? (Y/N)


 
rentalFlag
boolean
Rental/Owned


 
ratedPowerHP
integer <int32> 
Rated Power (HP)


 
ratedPowerKW
integer <int32> 
Rated Power (KW)


 
defaultFuel
string or null
Default Fuel


 
purchaseDate
string <date-time> 
Purchase Date


 
purchasePrice
number <double> 
Purchase Value


 
resalePrice
number <double> 
Resale Value


 
depreciationMethod
integer <int32> 
Depreciation Method (0 = Declining Balance, 1 = Straight Line)


 
depreciationYears
integer <int32> 
Depreciation Years


 
depreciationMonths
integer <int32> 
Depreciation Months


 
replacementCycleYears
number <double> 
Replacement Cycle Years


 
utilizedHoursPerYear
integer <int32> 
Utilized Hours Per Year


 
utilizedMilesPerYear
integer <int32> 
Utilized Miles Per Year


 
budget
number <double> 
Budget Value


 
jobCode
string or null
Job code associated with the equipment.


 
locationName
string or null
Location associated with the equipment.


 
onLoanBusinessUnitID
string or null <uuid> 
The ID associated with the Business Unit that the equipment is currently on-loan to.


 
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/equipment
Request samples 
{
  • "businessUnitId": "214dd610-35bc-4504-9246-7073493e0400",
  • "code": "string",
  • "equipmentType": "string",
  • "description": "string",
  • "accountingCode": "string",
  • "make": "string",
  • "model": "string",
  • "year": 0,
  • "vin": "string",
  • "serialNo": "string",
  • "hourMeter": 0,
  • "hourMeterDate": "2019-08-24T14:15:22Z",
  • "odometer": 0,
  • "odometerDate": "2019-08-24T14:15:22Z",
  • "imageUrl": "string",
  • "region": "string",
  • "division": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "numberAxles": 0,
  • "tireSize": "string",
  • "status": "string",
  • "enabled": "string",
  • "rentalFlag": true,
  • "ratedPowerHP": 0,
  • "ratedPowerKW": 0,
  • "defaultFuel": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "purchasePrice": 0,
  • "resalePrice": 0,
  • "depreciationMethod": 0,
  • "depreciationYears": 0,
  • "depreciationMonths": 0,
  • "replacementCycleYears": 0,
  • "utilizedHoursPerYear": 0,
  • "utilizedMilesPerYear": 0,
  • "budget": 0,
  • "jobCode": "string",
  • "locationName": "string",
  • "onLoanBusinessUnitID": "ebf3f39e-de4c-4c2b-aa9a-8f6860e12b8e"
}
Response samples 
application/json
{
  • "id": "712b78b5-b10e-4df9-a6ee-1747754abb7b",
  • "equipmentId": 13,
  • "businessUnitId": "f25e722e-3944-455b-b81a-de16fd569672",
  • "code": "DZ-101",
  • "equipmentType": "Dozer",
  • "description": "The big yellow one.",
  • "accountingCode": "HOLYMOLY",
  • "make": "Komatsu",
  • "model": "D39EXi-24",
  • "year": 2021,
  • "vin": "JF1GV7F67DG002982",
  • "serialNo": "Test",
  • "hourMeter": 3829,
  • "hourMeterDate": "2020-06-07T00:00:00",
  • "odometer": 0,
  • "imageUrl": "",
  • "region": "",
  • "division": "",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "numberAxles": 0,
  • "tireSize": "",
  • "status": "Available",
  • "enabled": "Y",
  • "rentalFlag": false,
  • "ratedPowerHP": 0,
  • "ratedPowerKW": 0,
  • "defaultFuel": "",
  • "purchaseDate": "2000-01-01T00:00:00Z",
  • "purchasePrice": 100000,
  • "jobCode": "867-5309",
  • "locationName": "",
  • "onLoanBusinessUnitID": "00000000-0000-0000-0000-000000000000"
}
Returns a single equipment record, based on its Id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the equipment to be return.


 
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/equipment/{id}
Request samples 
Response samples 
application/json
{
  • "id": "712b78b5-b10e-4df9-a6ee-1747754abb7b",
  • "equipmentId": 13,
  • "businessUnitId": "f25e722e-3944-455b-b81a-de16fd569672",
  • "code": "DZ-101",
  • "equipmentType": "Dozer",
  • "description": "The big yellow one.",
  • "accountingCode": "HOLYMOLY",
  • "make": "Komatsu",
  • "model": "D39EXi-24",
  • "year": 2021,
  • "vin": "JF1GV7F67DG002982",
  • "serialNo": "Test",
  • "hourMeter": 3829,
  • "hourMeterDate": "2020-06-07T00:00:00",
  • "odometer": 0,
  • "imageUrl": "",
  • "region": "",
  • "division": "",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "numberAxles": 0,
  • "tireSize": "",
  • "status": "Available",
  • "enabled": "Y",
  • "rentalFlag": false,
  • "ratedPowerHP": 0,
  • "ratedPowerKW": 0,
  • "defaultFuel": "",
  • "purchaseDate": "2000-01-01T00:00:00Z",
  • "purchasePrice": 100000,
  • "jobCode": "867-5309",
  • "locationName": "",
  • "onLoanBusinessUnitID": "00000000-0000-0000-0000-000000000000"
}
Update equipment record, based on its Id.
For help with authorization, see https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The Id of the equipment to be updated.


 
Request Body schema: 
The details of the equipment to be updated.


code
string or null
The equipment's code.


 
equipmentType
string or null
The equipment's type name.


 
description
string or null
A description of the equipment.


 
accountingCode
string or null
Equipment Accounting Code


 
make
string or null
The equipment's make.


 
model
string or null
The equipment's model.


 
year
integer or null <int32> 
The equipment's year.


 
vin
string or null
The equipment's VIN.


 
serialNo
string or null
The equipment's serial number.


 
hourMeter
integer <int32> 
If initialized, the most recent hour reading.


 
hourMeterDate
string or null <date-time> 
If initialized, the most recent hour reading date.


 
odometer
integer <int32> 
If initialized, the most recent odometer reading .


 
odometerDate
string or null <date-time> 
If initialized, the most recent odometer reading date.


 
imageUrl
string or null
The full URL of the equipment's image at Equipment360's document storage endpoint. Can be retrieved with a valid HCSS Apps access token.


 
region
string or null
The equipment's current region.


 
division
string or null
The equipment's current division.


 
weight
number <double> 
The equipment's unloaded weight.


 
length
number <double> 
The equipment's length.


 
width
number <double> 
The equipment's length.


 
height
number <double> 
The equipment's height.


 
numberAxles
integer <int32> 
Number of axles on the equipment.


 
tireSize
string or null
Tire Size Front / Rear


 
status
string or null
Status


 
enabled
string or null
Enabled? (Y/N)


 
rentalFlag
boolean
Rental/Owned


 
ratedPowerHP
integer <int32> 
Rated Power (HP)


 
ratedPowerKW
integer <int32> 
Rated Power (KW)


 
defaultFuel
string or null
Default Fuel


 
purchaseDate
string <date-time> 
Purchase Date


 
purchasePrice
number <double> 
Purchase Value


 
resalePrice
number <double> 
Resale Value


 
depreciationMethod
integer <int32> 
Depreciation Method (0 = Declining Balance, 1 = Straight Line)


 
depreciationYears
integer <int32> 
Depreciation Years


 
depreciationMonths
integer <int32> 
Depreciation Months


 
replacementCycleYears
number <double> 
Replacement Cycle Years


 
utilizedHoursPerYear
integer <int32> 
Utilized Hours Per Year


 
utilizedMilesPerYear
integer <int32> 
Utilized Miles Per Year


 
budget
number <double> 
Budget Value


 
locationName
string or null
Location associated with the equipment.


 
jobCode
string or null
Job code associated with the equipment.


 
onLoanBusinessUnitID
string or null <uuid> 
The ID associated with the Business Unit that the equipment is currently on-loan to.


 
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.


put/api/v1/equipment/{id}
Request samples 
{
  • "code": "string",
  • "equipmentType": "string",
  • "description": "string",
  • "accountingCode": "string",
  • "make": "string",
  • "model": "string",
  • "year": 0,
  • "vin": "string",
  • "serialNo": "string",
  • "hourMeter": 0,
  • "hourMeterDate": "2019-08-24T14:15:22Z",
  • "odometer": 0,
  • "odometerDate": "2019-08-24T14:15:22Z",
  • "imageUrl": "string",
  • "region": "string",
  • "division": "string",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "numberAxles": 0,
  • "tireSize": "string",
  • "status": "string",
  • "enabled": "string",
  • "rentalFlag": true,
  • "ratedPowerHP": 0,
  • "ratedPowerKW": 0,
  • "defaultFuel": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "purchasePrice": 0,
  • "resalePrice": 0,
  • "depreciationMethod": 0,
  • "depreciationYears": 0,
  • "depreciationMonths": 0,
  • "replacementCycleYears": 0,
  • "utilizedHoursPerYear": 0,
  • "utilizedMilesPerYear": 0,
  • "budget": 0,
  • "locationName": "string",
  • "jobCode": "string",
  • "onLoanBusinessUnitID": "ebf3f39e-de4c-4c2b-aa9a-8f6860e12b8e"
}
Response samples 
application/json
{
  • "id": "712b78b5-b10e-4df9-a6ee-1747754abb7b",
  • "equipmentId": 13,
  • "businessUnitId": "f25e722e-3944-455b-b81a-de16fd569672",
  • "code": "DZ-101",
  • "equipmentType": "Dozer",
  • "description": "The big yellow one.",
  • "accountingCode": "HOLYMOLY",
  • "make": "Komatsu",
  • "model": "D39EXi-24",
  • "year": 2021,
  • "vin": "JF1GV7F67DG002982",
  • "serialNo": "Test",
  • "hourMeter": 3829,
  • "hourMeterDate": "2020-06-07T00:00:00",
  • "odometer": 0,
  • "imageUrl": "",
  • "region": "",
  • "division": "",
  • "weight": 0,
  • "length": 0,
  • "width": 0,
  • "height": 0,
  • "numberAxles": 0,
  • "tireSize": "",
  • "status": "Available",
  • "enabled": "Y",
  • "rentalFlag": false,
  • "ratedPowerHP": 0,
  • "ratedPowerKW": 0,
  • "defaultFuel": "",
  • "purchaseDate": "2000-01-01T00:00:00Z",
  • "purchasePrice": 100000,
  • "jobCode": "867-5309",
  • "locationName": "",
  • "onLoanBusinessUnitID": "00000000-0000-0000-0000-000000000000"
}