Retrieve Equipment
Retrieve the details of an existing Equipment.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- name string
The name for this Equipment.
- brand string
The name of the brand which makes this Equipment.
- model string
The model name of this Equipment.
- serial_number string
The serial number of this Equipment.
- equipment_type_id integer
Possible values:
>= 1
- type_name string
The name of the associated
Equipment Type
. - equipment_status_id integer
Possible values:
>= 1
- status_name string
The name of the associated
Equipment Status
. - group_id NullableId
Possible values:
>= 1
- group_name string
The name of the associated
Group
. - purchase_vendor_id NullableId
Possible values:
>= 1
- purchase_price_cents integer
The purchase price in cents.
- purchase_date date
The date on which the Equipment was purchased.
- estimated_resale_price float
The estimated resale price of this Equipment.
- warranty_expiration_date date
The date on which the Equipment warranty expires.
- purchase_comments string
Any comments about the purchase of this Equipment.
- custom_fields object
*Full details on working with Custom Fields here.
- in_service_date date
The date on which the Equipment was put into service.
- estimated_service_life integer
The estimated duration in months of the service life for this Equipment.
- out_of_service_date date
The estimated date on which the Equipment will be retired from service.
- archived_at date-time
The date and time at which the Equipment was archived.
- status_color string
The color of the associated
Equipment Status
. linked_vehicle object
A Vehicle
id integercreated_at date-timeupdated_at date-timeaccount_id integerPossible values:
>= 1
archived_at date-timeThe date and time at which the Vehicle was archived.
fuel_type_id NullableIdPossible values:
>= 1
fuel_type_name stringThe name of the
Fuel Type
associated with this Vehicle.fuel_volume_units VolumeUnitPossible values: [
us_gallons
,uk_gallons
,liters
]group_id NullableIdPossible values:
>= 1
group_name stringThe name of the
Group
associated with this Vehicle.meter_unit MeterUnitPossible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
name stringThis Vehicle's name.
ownership VehicleOwnershipResponsePossible values: [
Owned
,Leased
,Rented
,Customer
]secondary_meter booleanIndicates whether or not this Vehicle has a secondary meter.
secondary_meter_unit MeterUnitPossible values: [
km
,hr
,mi
]The measurement unit used for the Vehicle's primary, or secondary (if applicable), meter.
system_of_measurement MeasurementSystemPossible values: [
imperial
,metric
]vehicle_status_id integerPossible values:
>= 1
vehicle_status_name stringThe name of the
Vehicle Status
associated with this Vehicle.vehicle_status_color stringThe color of the
Vehicle Status
associated with this Vehicle.vehicle_type_id integerPossible values:
>= 1
vehicle_type_name stringThe name of the
Vehicle Type
associated with this Vehicle.fuel_entries_count integerThe number of
Fuel Entries
associated with this Vehicle.service_entries_count integerThe number of
Service Entries
associated with this Vehicle.service_reminders_count integerThe number of
Service Reminders
associated with this Vehicle.vehicle_renewal_reminders_count integerThe number of
Vehicle Renewal Reminders
associated with this Vehicle.comments_count integerThe number of
Comments
associated with this Vehicle.documents_count integerThe number of documents attached to this Vehicle.
images_count integerThe number of images attached to this Vehicle.
current_location_entry_id NullableIdPossible values:
>= 1
is_sample booleanIndicates whether this Vehicle record is Sample Data.
in_service_date date-timeThe date on which this Vehicle was put into service.
in_service_meter floatThe meter value at which this Vehicle was put into service.
estimated_service_months integerThe estimated number of months this Vehicle will be in service.
estimated_replacement_mileage stringThe estimated number of miles before which this Vehicle will be replaced.
estimated_resale_price object
The estimated resale price of this Vehicle.
cents integerThe estimated resale price of this Vehicle in cents.
currency_iso stringThe ISO 4217 currency code of the estimated resale price.
out_of_service_date date-timeThe date on which this Vehicle was or will be retired.
out_of_service_meter floatThe meter value at which this Vehicle was or will be retired.
meter_name stringThe name of the primary meter for this Vehicle.
secondary_meter_name stringThe name of the secondary meter for this Vehicle.
primary_meter_usage_per_day stringThe average number of units of the primary meter used per day.
secondary_meter_usage_per_day stringThe average number of units of the secondary meter used per day.
current_meter_value floatThe current value of the primary meter for this Vehicle.
current_meter_date date-timeThe date and time at which the primary meter was last updated.
secondary_meter_value floatThe current value of the secondary meter for this Vehicle.
secondary_meter_date date-timeThe date and time at which the secondary meter was last updated.
group_ancestry stringThe ancestry of the Group associated with this Vehicle.
color stringThe color of this Vehicle.
license_plate stringThe license plate number of this Vehicle.
vin stringThe Vehicle Identification Number of this Vehicle.
year stringThis Vehicle's model year.
make stringThe name of this Vehicle's manufacturer.
model stringThe name of the model of this Vehicle.
trim stringThe trim level of this Vehicle.
registration_expiration_month integerPossible values:
<= 12
The month in which this Vehicle's registration expires.
registration_state stringThe state, province, or territory in which this Vehicle is registered.
loan_account_number stringThe account number for this Vehicle's loan, if applicable.
loan_ended_at date-timeThe date and time at which this Vehicle's loan ends.
loan_interest_rate floatThe interest rate for this Vehicle's loan.
loan_notes stringNotes about this Vehicle's loan.
loan_started_at date-timeThe date and time at which this Vehicle's loan began. Formatted according to ISO-8601 in
User
's local time.loan_vendor_id NullableIdPossible values:
>= 1
loan_vendor_name stringThe name of the
Vendor
for this Vehicle's loan.custom_fields object*Full details on working with Custom Fields here.
inspection_schedules_count integerThe number of inspection schedules this Vehicle is associated with.
issues_count integerThe number of
Issues
this Vehicle is associated with.work_orders_count integerThe number of
Work Orders
this Vehicle is associated with.type_name stringThe name of the
Vehicle Type
associated with this Vehicle.default_image_url stringThe URL of the default image for this Vehicle.
default_image_url_medium stringThe URL of a medium-sized version of the default image for this Vehicle.
default_image_url_small stringThe URL of a small-sized version of the default image for this Vehicle.
default_image_url_large stringThe URL of a large-sized version of the default image for this Vehicle.
specs object
id integerPossible values:
>= 1
vehicle_id integerThe
Vehicle
ID these specs belong to.account_id integerbody_type stringThe body type of the Vehicle, if available.
body_subtype stringThe subtype of the Vehicle body, if available.
drive_type stringThe drive type of the Vehicle, if available.
brake_system stringThe brake system used in the Vehicle, if available.
msrp_cents integerThe Manufacturer's Suggested Retail Price (MSRP) in cents, if available.
fuel_tank_capacity floatThe fuel tank capacity of the Vehicle, if available.
fuel_tank_2_capacity floatThe capacity of a second fuel tank, if available.
front_track_width floatThe front track width of the Vehicle, if available.
ground_clearance floatThe ground clearance of the Vehicle, if available.
height floatThe height of the Vehicle, if available.
length floatThe length of the Vehicle, if available.
rear_track_width floatThe rear track width of the Vehicle, if available.
width floatThe width of the Vehicle, if available.
wheelbase floatThe wheelbase of the Vehicle, if available.
front_tire_psi stringThe recommended PSI for front tires, if available.
rear_tire_psi stringThe recommended PSI for rear tires, if available.
base_towing_capacity stringThe base towing capacity of the Vehicle, if available.
curb_weight floatThe curb weight of the Vehicle, if available.
gross_vehicle_weight_rating floatThe Gross Vehicle Weight Rating (GVWR), if available.
bed_length stringThe length of the Vehicle's bed, if available.
max_payload stringThe maximum payload capacity of the Vehicle, if available.
rear_axle_type stringThe type of rear axle used in the Vehicle.
front_tire_type stringThe type of front tires used in the Vehicle.
front_wheel_diameter stringThe diameter of the front wheels.
rear_tire_type stringThe type of rear tires used in the Vehicle.
rear_wheel_diameter stringThe diameter of the rear wheels.
epa_city floatThe EPA city fuel economy rating, if available.
epa_highway floatThe EPA highway fuel economy rating, if available.
epa_combined floatThe combined EPA fuel economy rating, if available.
engine_description stringDescription of the Vehicle's engine.
engine_brand stringBrand of the Vehicle's engine.
engine_aspiration stringAspiration type of the engine, if available.
engine_block_type stringBlock type of the engine, if available.
engine_bore stringBore size of the engine, if available.
engine_cam_type stringCamshaft type of the engine, if available.
engine_compression stringCompression ratio of the engine, if available.
engine_cylinders integerNumber of engine cylinders, if available.
engine_displacement stringEngine displacement, if available.
fuel_induction stringFuel induction method, if available.
fuel_quality stringFuel quality required for the engine.
max_hp stringMaximum horsepower produced by the engine, if available.
max_torque stringMaximum torque produced by the engine, if available.
oil_capacity stringOil capacity of the engine, if available.
redline_rpm stringRedline RPM of the engine.
engine_stroke stringStroke length of the engine, if available.
engine_valves integerNumber of engine valves, if available.
transmission_description stringDescription of the Vehicle's transmission.
transmission_brand stringBrand of the Vehicle's transmission.
transmission_type stringType of transmission, if available.
transmission_gears integerNumber of gears in the transmission, if available.
cargo_volume floatCargo volume of the Vehicle, if available.
interior_volume floatInterior volume of the Vehicle, if available.
passenger_volume stringPassenger volume of the Vehicle.
created_at date-timeThe date and time when the specs were created.
updated_at date-timeThe date and time when the specs were last updated.
duty_type stringType of duty the Vehicle is designed for, if available.
weight_class stringWeight class of the Vehicle, if available.
engine_bore_with_units stringBore size of the engine with units, if available.
wheelbase_with_units stringWheelbase of the Vehicle with units, if available.
msrp stringManufacturer's Suggested Retail Price (MSRP).
external_ids objectAny External IDs associated with this Vehicle.
ai_enabled booleanWhether this Vehicle has Auto Integrate enabled for it.
assetable_type stringPossible values: [
Vehicle
]Assetable type for Vehicle is always
Vehicle
for vehicles.driver object
id NullableIdPossible values:
>= 1
first_name stringThe first name of the
Contact
(driver) associated with this Vehicle.last_name stringThe last name of the
Contact
(driver) associated with this Vehicle.full_name stringThe full name of the
Contact
(driver) associated with this Vehicle.default_image_url stringThe URL of the default image of the
Contact
(driver) associated with this Vehicle.current_location_entry object
The current location of the associated object.
id integerThe unique identifier for the current Location Entry.
locatable_type stringThe type of object that this Location Entry is associated with.
locatable_id integerThe unique identifier of the object that this Location Entry is associated with.
date date-timeThe date and time when this Location Entry was recorded.
created_at date-timeThe date and time when this Location Entry was created.
updated_at date-timeThe date and time when this Location Entry was last updated.
contact_id integerThe unique identifier of the associated Contact.
address stringThe address associated with this Location Entry.
is_current booleanIndicates whether this Location Entry is the current location.
item_type stringThe type of item associated with this Location Entry.
item_id integerThe unique identifier of the item associated with this Location Entry.
location stringThe geographical location in the format "POINT (longitude latitude)".
address_components object
street_number stringThe street number in the address.
street stringThe street name in the address.
city stringThe city in the address.
region stringThe region, state or province in the address.
region_short stringThe abbreviated region, state or province code.
country stringThe country in the address.
country_short stringThe abbreviated country code.
postal_code stringThe postal code, ZIP, or equivalent in the address.
geolocation object
latitude floatThe latitude coordinate of the location.
longitude floatThe longitude coordinate of the location.
loan_amount floatThe amount of this Vehicle's loan.
loan_payment floatThe amount of this Vehicle's loan payment.
warranties_active_count integerThe number of active warranties associated with this Vehicle.
warranties_count integerThe number of warranties associated with this Vehicle.
residual_value floatThe residual value of this Vehicle at the end of its lease.
axle_config_id integerThe id of the
Axle Configuration
of this vehicle.assigned_contact object
A Contact
id integercreated_at date-timeupdated_at date-timeemail stringThe Contact's email address.
name stringThe Contact's full name.
first_name stringThe Contact's first name.
middle_name stringThe Contact's middle name.
last_name stringThe Contact's last name.
images_count integerThe number of images associated with this Contact.
documents_count integerThe number of documents associated with this Contact.
comments_count integerThe number of comments associated with this Contact.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.group_name stringIf this Contact belongs to a Group, this will be the
Group
's name.group_hierarchy stringIf this Contact belongs to a Group, this will be a pipe delimited string representing the
Group
hierarchy. EachGroup
in the list is the parent of theGroups
which follow.technician booleanWhether or not the Contact is a Technician.
vehicle_operator booleanWhether or not the Contact is a Vehicle Operator.
employee booleanWhether or not the Contact is an Employee.
birth_date dateThe Contact's birth date.
street_address stringThe Contact's street address.
street_address_line_2 stringThe Contact's street address line 2.
city stringThe Contact's city.
region stringThe Contact's region, state, or province.
postal_code stringThe Contact's postal code, zip code, or equivalent.
country stringThe Contact's country.
employee_number stringThe Contact's employee number.
job_title stringPossible values:
<= 255 characters
The Contact's job title.
license_class stringThe Contact's driver's license class.
license_number stringThe Contact's driver's license number.
license_state stringThe locality which issued the Contact's license.
license_expiration dateThe Contact's driver's license expiration date.
home_phone_number stringThe Contact's home phone number.
mobile_phone_number stringThe Contact's mobile phone number.
work_phone_number stringThe Contact's work phone number.
other_phone_number stringAny other phone number for this Contact.
start_date dateWhen the Contact started working for the company, if applicable.
leave_date dateWhen the Contact left or will leave the company, if applicable.
hourly_labor_rate floatThe Contact's hourly rate.
custom_fields object*Full details on working with Custom Fields here.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
default_image_url stringThe URL of the Contact's default image/profile photo, if any.
user objectIf the Contact is a Fleetio
User
, those details will be included here.account_membership_id NullableIdPossible values:
>= 1
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
- default_image_url string
The URL of the Equipment's default image/profile photo, if any.
- assetable_type string
The type of assetable object.
- issues_count integer
The number of
Issues
associated with this Equipment. current_location_entry object
The current location of the associated object.
id integerThe unique identifier for the current Location Entry.
locatable_type stringThe type of object that this Location Entry is associated with.
locatable_id integerThe unique identifier of the object that this Location Entry is associated with.
date date-timeThe date and time when this Location Entry was recorded.
created_at date-timeThe date and time when this Location Entry was created.
updated_at date-timeThe date and time when this Location Entry was last updated.
contact_id integerThe unique identifier of the associated Contact.
address stringThe address associated with this Location Entry.
is_current booleanIndicates whether this Location Entry is the current location.
item_type stringThe type of item associated with this Location Entry.
item_id integerThe unique identifier of the item associated with this Location Entry.
location stringThe geographical location in the format "POINT (longitude latitude)".
address_components object
street_number stringThe street number in the address.
street stringThe street name in the address.
city stringThe city in the address.
region stringThe region, state or province in the address.
region_short stringThe abbreviated region, state or province code.
country stringThe country in the address.
country_short stringThe abbreviated country code.
postal_code stringThe postal code, ZIP, or equivalent in the address.
geolocation object
latitude floatThe latitude coordinate of the location.
longitude floatThe longitude coordinate of the location.
- comments_count integer
The number of
Comments
associated with this Equipment. - documents_count integer
The number of documents associated with this Equipment.
- images_count integer
The number of images associated with this Equipment.
- is_watched boolean
Default value:
false
Indicates whether this Equipment is being watched.
- watchers_count integer
The number of users watching this Equipment.
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"brand": "string",
"model": "string",
"serial_number": "string",
"equipment_type_id": 0,
"type_name": "string",
"equipment_status_id": 0,
"status_name": "string",
"group_id": 0,
"group_name": "string",
"purchase_vendor_id": 0,
"purchase_price_cents": 0,
"purchase_date": "2023-03-14",
"estimated_resale_price": 0,
"warranty_expiration_date": "2023-03-14",
"purchase_comments": "string",
"custom_fields": {},
"in_service_date": "2023-03-14",
"estimated_service_life": 0,
"out_of_service_date": "2023-03-14",
"archived_at": "2024-10-02",
"status_color": "string",
"linked_vehicle": {
"id": 0,
"created_at": "2024-10-02",
"updated_at": "2024-10-02",
"account_id": 0,
"archived_at": "2023-03-14T13:46:27-06:00",
"fuel_type_id": 0,
"fuel_type_name": "string",
"fuel_volume_units": "us_gallons",
"group_id": 0,
"group_name": "string",
"meter_unit": "km",
"name": "string",
"ownership": "Owned",
"secondary_meter": true,
"secondary_meter_unit": "km",
"system_of_measurement": "imperial",
"vehicle_status_id": 0,
"vehicle_status_name": "string",
"vehicle_status_color": "string",
"vehicle_type_id": 0,
"vehicle_type_name": "string",
"fuel_entries_count": 0,
"service_entries_count": 0,
"service_reminders_count": 0,
"vehicle_renewal_reminders_count": 0,
"comments_count": 0,
"documents_count": 0,
"images_count": 0,
"current_location_entry_id": 0,
"is_sample": true,
"in_service_date": "2023-03-14T13:46:27-06:00",
"in_service_meter": 0,
"estimated_service_months": 0,
"estimated_replacement_mileage": "string",
"estimated_resale_price": {
"cents": 0,
"currency_iso": "string"
},
"out_of_service_date": "2023-03-14T13:46:27-06:00",
"out_of_service_meter": 0,
"meter_name": "string",
"secondary_meter_name": "string",
"primary_meter_usage_per_day": "string",
"secondary_meter_usage_per_day": "string",
"current_meter_value": 0,
"current_meter_date": "2023-03-14T13:46:27-06:00",
"secondary_meter_value": 0,
"secondary_meter_date": "2023-03-14T13:46:27-06:00",
"group_ancestry": "string",
"color": "string",
"license_plate": "string",
"vin": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"registration_expiration_month": 0,
"registration_state": "string",
"loan_account_number": "string",
"loan_ended_at": "2023-03-14T13:46:27-06:00",
"loan_interest_rate": 0,
"loan_notes": "string",
"loan_started_at": "2023-03-14T13:46:27-06:00",
"loan_vendor_id": 0,
"loan_vendor_name": "string",
"custom_fields": {},
"inspection_schedules_count": 0,
"issues_count": 0,
"work_orders_count": 0,
"type_name": "string",
"default_image_url": "string",
"default_image_url_medium": "string",
"default_image_url_small": "string",
"default_image_url_large": "string",
"specs": {
"id": 0,
"vehicle_id": 0,
"account_id": 0,
"body_type": "string",
"body_subtype": "string",
"drive_type": "string",
"brake_system": "string",
"msrp_cents": 0,
"fuel_tank_capacity": 0,
"fuel_tank_2_capacity": 0,
"front_track_width": 0,
"ground_clearance": 0,
"height": 0,
"length": 0,
"rear_track_width": 0,
"width": 0,
"wheelbase": 0,
"front_tire_psi": "string",
"rear_tire_psi": "string",
"base_towing_capacity": "string",
"curb_weight": 0,
"gross_vehicle_weight_rating": 0,
"bed_length": "string",
"max_payload": "string",
"rear_axle_type": "string",
"front_tire_type": "string",
"front_wheel_diameter": "string",
"rear_tire_type": "string",
"rear_wheel_diameter": "string",
"epa_city": 0,
"epa_highway": 0,
"epa_combined": 0,
"engine_description": "string",
"engine_brand": "string",
"engine_aspiration": "string",
"engine_block_type": "string",
"engine_bore": "string",
"engine_cam_type": "string",
"engine_compression": "string",
"engine_cylinders": 0,
"engine_displacement": "string",
"fuel_induction": "string",
"fuel_quality": "string",
"max_hp": "string",
"max_torque": "string",
"oil_capacity": "string",
"redline_rpm": "string",
"engine_stroke": "string",
"engine_valves": 0,
"transmission_description": "string",
"transmission_brand": "string",
"transmission_type": "string",
"transmission_gears": 0,
"cargo_volume": 0,
"interior_volume": 0,
"passenger_volume": "string",
"created_at": "2024-10-02",
"updated_at": "2024-10-02",
"duty_type": "string",
"weight_class": "string",
"engine_bore_with_units": "string",
"wheelbase_with_units": "string",
"msrp": "string"
},
"external_ids": {},
"ai_enabled": true,
"assetable_type": "Vehicle",
"driver": {
"id": 0,
"first_name": "string",
"last_name": "string",
"full_name": "string",
"default_image_url": "string"
},
"current_location_entry": {
"id": 0,
"locatable_type": "string",
"locatable_id": 0,
"date": "2024-10-02",
"created_at": "2024-10-02",
"updated_at": "2024-10-02",
"contact_id": 0,
"address": "string",
"is_current": true,
"item_type": "string",
"item_id": 0,
"location": "string",
"address_components": {
"street_number": "string",
"street": "string",
"city": "string",
"region": "string",
"region_short": "string",
"country": "string",
"country_short": "string",
"postal_code": "string"
},
"geolocation": {
"latitude": 0,
"longitude": 0
}
},
"loan_amount": 0,
"loan_payment": 0,
"warranties_active_count": 0,
"warranties_count": 0,
"residual_value": 0,
"axle_config_id": 0
},
"assigned_contact": {
"id": 0,
"created_at": "2024-10-02",
"updated_at": "2024-10-02",
"email": "string",
"name": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"images_count": 0,
"documents_count": 0,
"comments_count": 0,
"group_id": 0,
"group_name": "string",
"group_hierarchy": "Group 1|Group 2|Group 3",
"technician": true,
"vehicle_operator": true,
"employee": true,
"birth_date": "2023-03-14",
"street_address": "123 Main St",
"street_address_line_2": "Apt 1",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"employee_number": "string",
"job_title": "string",
"license_class": "string",
"license_number": "string",
"license_state": "string",
"license_expiration": "2023-03-14",
"home_phone_number": "string",
"mobile_phone_number": "string",
"work_phone_number": "string",
"other_phone_number": "string",
"start_date": "2024-10-02",
"leave_date": "2024-10-02",
"hourly_labor_rate": 0,
"custom_fields": {},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"user": {},
"account_membership_id": 0
},
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"default_image_url": "string",
"assetable_type": "string",
"issues_count": 0,
"current_location_entry": {
"id": 0,
"locatable_type": "string",
"locatable_id": 0,
"date": "2024-10-02",
"created_at": "2024-10-02",
"updated_at": "2024-10-02",
"contact_id": 0,
"address": "string",
"is_current": true,
"item_type": "string",
"item_id": 0,
"location": "string",
"address_components": {
"street_number": "string",
"street": "string",
"city": "string",
"region": "string",
"region_short": "string",
"country": "string",
"country_short": "string",
"postal_code": "string"
},
"geolocation": {
"latitude": 0,
"longitude": 0
}
},
"comments_count": 0,
"documents_count": 0,
"images_count": 0,
"is_watched": false,
"watchers_count": 0
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}