Update Equipment By ID

put

https://platform.roserocket.com/api/v1/equipment/{equipmentID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

equipmentID

string

required

ID of the equipment. It could also be the external ID of the equipment, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the equipment's external ID is test123 then the value of equipmentID should be ext:test1234 or external_id:test1234.

Body Params

Equipment Update Object

Represents a piece of equipment typically owned by a carrier inclusive of equipment file, license, type and subtype information..

name

string

The name of the equipment

description

string

The description of the equipment

org_id

uuid

The uuid of the org that owns the equipment

equipment_type_id

uuid

The uuid of this equipment's type

equipment_sub_type_id

uuid

The uuid of this equipment's subtype

external_id

string

An external identifier for this equipment

manager_user_id

uuid

The id of the user that manages this piece of equipment

manager_full_name

string

The name of the user that managest his piece of equipment

length

number

The length of this equipment

width

number

The width of this equipment

height

number

The height of this equipment

max_weight

number

The maximum weight of this equipment

weight_unit_id

string

enum

Allowed:

measurement_unit_id

string

enum

Allowed:

equipment_status_id

string

The status of this equipment

is_assigned_to_manifest

boolean

Whether or not this piece of equipment is assigned to a manifest

is_manifest_in_transit

boolean

Whether or not this piece of equipment's manifest is in transit

vin

string

The Vehicle Insurance Number of this equipment

bill_item_type_id

string

The id of the bill item type for this equipment

pay_type_id

string

The id of the pay type for this equipment

pay_amount

number

equipment_licenses

array of objects

equipment_licenses

equipment_files

array of objects

equipment_files

equipment_type

object

Represents an equipment's type

equipment_sub_type

object

Represents an equipment's type

connector_mappings

object

A (key, object) map, where the key is connector ID (represents the vendor) and the object contains vendor details associated with this Rose Rocket equipment.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation

400Bad request