Cars

Cars Resource in the University API - Tutorial

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/tutorial/cars

Version: v1

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/ GET

Cars summary to be less than 120 characters

OPTIONS

Cars

POST

Cars

/{vin} DELETE

Cars

GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/insurance_policies DELETE

Cars

GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/maintenance_logs GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/maintenance_logs/{maintenance_id} DELETE

Cars

GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/odometer_logs GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/odometer_logs/{read_date} DELETE

Cars

GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/trips GET

Cars

OPTIONS

Cars

PUT

Cars

/{vin}/trips/{trip_id} DELETE

Cars

GET

Cars

OPTIONS

Cars

PUT

Cars

Paths

Cars summary to be less than 120 characters

GET /

Tags: Cars

Retrieves a collection of Cars

application/json

always

You can reference this parameter definition from inside any path parameter definition

query integer (int32) #/parameters/alwaysUsedParameter
plate_state

License Plate State

query string
plate_number

License Plate Number

query string
vehicle_type

Type of Vehicle

query string
vehicle_year

Model Year of the Vehicle

query string
make

Make of the Vehicle

query string
model

Model of the Vehicle

query string
color

Color of the Vehicle

query string
owner_id

The ID of the owner of the vehicle

query string
page_start

Specifies how far to skip into a large set

query integer (int32) 1
page_size

Specifies how many items to return from a large set

query integer (int32) 50
field_sets

Field Sets Available

query string
contexts

Group of Field Sets

query string
insurance_policies.insurer

Insurance Agency of Insurance Policy

query string

application/json

200 OK

Collection Retrieved

Example for application/json
{
"links": {
"cars__create": {
"href": "https://api.byu.edu/domains/tutorials/cars",
"method": "POST",
"rel": "cars__create",
"title": "cars__createCar"
}
,
"cars__info": {
"href": "https://api.byu.edu/domains/tutorials/cars",
"method": "GET",
"rel": "self",
"title": "cars__getCars"
}
}
,
"metadata": {
"collection_size": 3,
"contexts_available": {
"mileage": [
"basic",
"odometer_log",
"trips"
]
}
,
"default_field_sets": [
"basic"
]
,
"default_page_size": 50,
"field_sets_available": [
"basic",
"odometer_log",
"trips",
"insurance",
"maintenance_log"
]
,
"field_sets_returned": [
"basic",
"odometer_log",
"trips",
"insurance",
"maintenance_log"
]
,
"max_page_size": 1000,
"page_end": 3,
"page_size": 50,
"page_start": 1
}
,
"values": [
{
"basic": {
"color": {
"api_type": "modifiable",
"display_label": "Color",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/color",
"value": "Dark Green"
}
,
"created_by_id": {
"api_type": "system",
"description": "Daffy Duck",
"value": "586586586"
}
,
"created_date_time": {
"api_type": "system",
"value": "2014-05-11T13:45:53.09Z"
}
,
"links": {
"cars__delete": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "DELETE",
"rel": "cars__delete",
"title": "cars__deleteCar"
}
,
"cars__info": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "GET",
"rel": "self",
"title": "cars__getCar"
}
,
"cars__modify": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "PUT",
"rel": "cars__modify",
"title": "cars__modifyCar"
}
,
"cars__sell": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962/salereceipts",
"method": "POST",
"rel": "cars__sell",
"title": "cars__sellCar"
}
,
"owners__info": {
"href": "https://api.byu.edu/domains/tutorials/owners/783783783",
"method": "GET",
"rel": "owners__info",
"title": "owners__getOwner"
}
}
,
"make": {
"api_type": "modifiable",
"display_label": "Make",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/make",
"value": "Toyota"
}
,
"model": {
"api_type": "modifiable",
"display_label": "Model",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/model/Toyota",
"value": "RAV4"
}
,
"owner_id": {
"api_type": "modifiable",
"value": "783783783"
}
,
"owner_name": {
"api_type": "related",
"related_resource": "tutorial5-owners",
"value": "Daisy Duck"
}
,
"plate_number": {
"api_type": "modifiable",
"display_label": "Licence Plate Number",
"value": "Q580RT"
}
,
"plate_state": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "Licence Plate State",
"domain": "https://api.byu.edu/domains/tutorials/meta/plate_state",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Daisy Duck",
"value": "783783783"
}
,
"updated_date_time": {
"api_type": "system",
"value": "2014-09-15T08:12:44.03Z"
}
,
"vehicle_type": {
"api_type": "derived",
"display_label": "Vehicle Type",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/vehicle-type",
"value": "Truck/SUV"
}
,
"vehicle_year": {
"api_type": "modifiable",
"display_label": "Vehicle Year",
"value": "2013"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
,
"insurance": {
"insurer": {
"api_type": "modifiable",
"display_label": "Insurance Agency",
"value": "GEICO"
}
,
"policy_id": {
"api_type": "modifiable",
"value": "A842B53E41"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
,
"maintenance_logs": [
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "283.45"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "Tune-up"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-06-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000354"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "152.83"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "Oil & Lube"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-11-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000418"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
,
"odometer_logs": [
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 32459
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-05-11"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 33782
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-06-08"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 35121
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "783783783"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daisy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-07-12"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
,
"trips": [
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Seattle, Washington"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2012-08-16"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 14826
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2012-08-10"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 10745
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A148"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Denver, Colorado"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-02-09"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 18144
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-02-04"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 17386
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "C233"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "San Francisco, California"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-06-26"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 24193
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-06-22"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 22354
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A432"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
},
{
"basic": {
"color": {
"api_type": "modifiable",
"display_label": "Color",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/color",
"value": "Blue"
}
,
"created_by_id": {
"api_type": "system",
"description": "Daffy Duck",
"value": "586586586"
}
,
"created_date_time": {
"api_type": "system",
"value": "2014-05-11T13:45:53.09Z"
}
,
"links": {
"cars__delete": {
"href": "https://api.byu.edu/domains/tutorials/cars/1DTGR14A6NP38861",
"method": "DELETE",
"rel": "cars__delete",
"title": "cars__deleteCar"
}
,
"cars__info": {
"href": "https://api.byu.edu/domains/tutorials/cars/1DTGR14A6NP38861",
"method": "GET",
"rel": "self",
"title": "cars__getCar"
}
,
"cars__modify": {
"href": "https://api.byu.edu/domains/tutorials/cars/1DTGR14A6NP38861",
"method": "PUT",
"rel": "cars__modify",
"title": "cars__modifyCar"
}
,
"cars__sell": {
"href": "https://api.byu.edu/domains/tutorials/cars/1DTGR14A6NP38861/salereceipts",
"method": "POST",
"rel": "cars__sell",
"title": "cars__sellCar"
}
,
"owners__info": {
"href": "https://api.byu.edu/domains/tutorials/owners/586586586",
"method": "GET",
"rel": "owners__info",
"title": "cars__getOwner"
}
}
,
"make": {
"api_type": "modifiable",
"display_label": "Make",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/make",
"value": "Ford"
}
,
"model": {
"api_type": "modifiable",
"display_label": "Model",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/model/Toyota",
"value": "Ranger"
}
,
"owner_id": {
"api_type": "modifiable",
"value": "586586586"
}
,
"owner_name": {
"api_type": "related",
"related_resource": "tutorial5-owners",
"value": "Daffy Duck"
}
,
"plate_number": {
"api_type": "modifiable",
"display_label": "Licence Plate Number",
"value": "C49D3T"
}
,
"plate_state": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "Licence Plate State",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/plate-state",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Daisy Duck",
"value": "783783783"
}
,
"updated_date_time": {
"api_type": "system",
"value": "2014-09-15T08:12:44.03Z"
}
,
"vehicle_type": {
"api_type": "derived",
"display_label": "Vehicle Type",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/vehicle-type",
"value": "Truck/SUV"
}
,
"vehicle_year": {
"api_type": "modifiable",
"display_label": "Vehicle Year",
"value": "1997"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
}
,
"insurance": {
"insurer": {
"api_type": "modifiable",
"display_label": "Insurance Agency",
"value": "State Farm"
}
,
"policy_id": {
"api_type": "modifiable",
"value": "421T84GX333"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
}
,
"maintenance_logs": [
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "533.12"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "New Tires"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-08-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000401"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
},
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "486.23"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "Replace Alternator"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2014-02-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000663"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
}
]
,
"odometer_logs": [
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 26438
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-05-09"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 29521
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-06-11"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 30114
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "783783783"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daisy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-07-15"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
}
]
,
"trips": [
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Butte, Montana"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2012-09-10"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 9854
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2012-09-06"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 8265
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A326"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "St. Louis, Missouri"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-01-12"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 15365
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-01-02"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 11843
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "D551"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "os Angeles, California"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-04-06"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 19632
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-04-01"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 17221
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A776"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1DTGR14A6NP38861"
}
}
]
},
{
"basic": {
"color": {
"api_type": "modifiable",
"display_label": "Color",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/color",
"value": "Tan"
}
,
"created_by_id": {
"api_type": "system",
"description": "Daffy Duck",
"value": "586586586"
}
,
"created_date_time": {
"api_type": "system",
"value": "2014-05-11T13:45:53.09Z"
}
,
"links": {
"cars__delete": {
"href": "https://api.byu.edu/domains/tutorials/cars/1CRTW25A3NX78232",
"method": "DELETE",
"rel": "cars__delete",
"title": "cars__deleteCar"
}
,
"cars__info": {
"href": "https://api.byu.edu/domains/tutorials/cars/1CRTW25A3NX78232",
"method": "GET",
"rel": "self",
"title": "cars__getCar"
}
,
"cars__modify": {
"href": "https://api.byu.edu/domains/tutorials/cars/1CRTW25A3NX78232",
"method": "PUT",
"rel": "cars__modify",
"title": "cars__modifyCar"
}
,
"cars__sell": {
"href": "https://api.byu.edu/domains/tutorials/cars/1CRTW25A3NX78232/salereceipts",
"method": "POST",
"rel": "cars__sell",
"title": "cars__sellCar"
}
,
"owners__info": {
"href": "https://api.byu.edu/domains/tutorials/owners/586586586",
"method": "GET",
"rel": "owners__info",
"title": "owners__getOwner"
}
}
,
"make": {
"api_type": "modifiable",
"display_label": "Make",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/make",
"value": "Chevrolet"
}
,
"model": {
"api_type": "modifiable",
"display_label": "Model",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/model/Toyota",
"value": "Sierra"
}
,
"owner_id": {
"api_type": "modifiable",
"value": "586586586"
}
,
"owner_name": {
"api_type": "related",
"related_resource": "tutorial5-owners",
"value": "Daffy Duck"
}
,
"plate_number": {
"api_type": "modifiable",
"display_label": "Licence Plate Number",
"value": "L43S3T"
}
,
"plate_state": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "Licence Plate State",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/plate-state",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Daisy Duck",
"value": "783783783"
}
,
"updated_date_time": {
"api_type": "system",
"value": "2014-09-15T08:12:44.03Z"
}
,
"vehicle_type": {
"api_type": "derived",
"display_label": "Vehicle Type",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/vehicle-type",
"value": "Truck/SUV"
}
,
"vehicle_year": {
"api_type": "modifiable",
"display_label": "Vehicle Year",
"value": "2003"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
}
,
"insurance": {
"insurer": {
"api_type": "modifiable",
"display_label": "Insurance Agency",
"value": "All State"
}
,
"policy_id": {
"api_type": "modifiable",
"value": "Y583958CV43"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
}
,
"maintenance_logs": [
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "2436.11"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "New Transmission"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-10-31"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000710"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
}
]
,
"odometer_logs": [
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 85919
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-05-03"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 90652
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"values": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"display_label": "something",
"key": true,
"value": "2014-06-22"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 94126
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "783783783"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daisy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"display_label": "something",
"key": true,
"value": "2014-07-21"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
}
]
,
"trips": [
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Pocatello, Idaho"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2011-04-10"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 19296
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2011-04-01"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 18542
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "B111"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Ely, Nevada"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-04-10"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 60946
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-04-01"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 60181
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "E028"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1CRTW25A3NX78232"
}
}
]
}
]
}
Custom-Header

A short description

string
400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Cars satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

Cars

OPTIONS /

Tags: Cars

What can this endpoint do?

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

POST /

Tags: Cars

Create a new Car

Uses default content-types: application/json

The Car to be added

car

Uses default content-types: application/json

201 Created

Car Added

car
400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

DELETE /{vin}

Tags: Cars

Delete a specific Car

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

204 No Content

Car successfully removed

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

Cars

GET /{vin}

Tags: Cars

Retrieves a specific Car

vin

Vehicle Identification Number

path string
field_sets

Field Sets Available

query string
contexts

Group of Field Sets

query string

Uses default content-types: application/json

200 OK

Item Retrieved

car
400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Cars satisfy the request - the collection is empty

Cars

OPTIONS /{vin}

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}

Tags: Cars

Modify a specific Car

Uses default content-types: application/json

The Car to be modified

car
vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Car Modified

car
400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

DELETE /{vin}/insurance_policies

Tags: Cars

Remove the insurance policy from this Car

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

204 No Content

Insurance Policy successfully removed

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

Cars

GET /{vin}/insurance_policies

Tags: Cars

Retrieves the insurance policy for a specific car

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Insurance Policy Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Insurance Policy satisfies the request - the collection is empty

Cars

OPTIONS /{vin}/insurance_policies

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/insurance_policies

Tags: Cars

Create or Modify a specific car's insurance policies

Uses default content-types: application/json

The Insurance Policy to be added or modified

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Insurance Policy Modified

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

GET /{vin}/maintenance_logs

Tags: Cars

Retrieves a collection of Maintenance Logs for a specific Car

vin

Vehicle Identification Number

path string
maintenance_date

When the maintenance was done on the Car

query string (date-time)
cost

Cost of Maintenance

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Maintenance Logs satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

Cars

OPTIONS /{vin}/maintenance_logs

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/maintenance_logs

Tags: Cars

Create a new maintenance log

Uses default content-types: application/json

The Maintenance Log to be added

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Maintenance Log Added

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

DELETE /{vin}/maintenance_logs/{maintenance_id}

Tags: Cars

Delete a specific Maintenance Log

vin

Vehicle Identification Number

path string
maintenance_id

Maintenance Log Identification Number

path string

Uses default content-types: application/json

204 No Content

Maintenance Log successfully removed

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

Cars

GET /{vin}/maintenance_logs/{maintenance_id}

Tags: Cars

Retrieves a specific Maintenance Log

vin

Vehicle Identification Number

path string
maintenance_id

Maintenance Log Identification Number

path string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Maintenance Logs satisfy the request - the collection is empty

Cars

OPTIONS /{vin}/maintenance_logs/{maintenance_id}

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string
maintenance_id

Maintenance Log Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/maintenance_logs/{maintenance_id}

Tags: Cars

Modify a specific Maintenance Log

Uses default content-types: application/json

The Maintenance Log to be modified

vin

Vehicle Identification Number

path string
maintenance_id

Maintenance Log Identification Number

path string

Uses default content-types: application/json

200 OK

Maintenance Log Modified

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

GET /{vin}/odometer_logs

Tags: Cars

Retrieves a collection of Odometer Logs for a specific Car

vin

Vehicle Identification Number

path string
read_date

When the odometer log was created

query string (date-time)
miles

Mileage read on odometer

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Odometer Logs satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

Cars

OPTIONS /{vin}/odometer_logs

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/odometer_logs

Tags: Cars

Creates a new Odometer Log

Uses default content-types: application/json

The Odometer Log to be added

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Odometer Log Added

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

DELETE /{vin}/odometer_logs/{read_date}

Tags: Cars

Delete a specific Odometer Log

vin

Vehicle Identification Number

path string
read_date

When the Odometer Log was created

path string (date-time)

Uses default content-types: application/json

204 No Content

Odometer Log successfully removed

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

Cars

GET /{vin}/odometer_logs/{read_date}

Tags: Cars

Retrieves a specific Odometer Log

vin

Vehicle Identification Number

path string
read_date

When the odometer log was created

path string (date-time)

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Odometer Logs satisfy the request - the collection is empty

Cars

OPTIONS /{vin}/odometer_logs/{read_date}

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string
read_date

When the Odometer Log was created

path string (date-time)

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/odometer_logs/{read_date}

Tags: Cars

Modify a specific Odometer Log

Uses default content-types: application/json

The Odometer Log to be modified

vin

Vehicle Identification Number

path string
read_date

When the odometer log was created

path string (date-time)

Uses default content-types: application/json

200 OK

Odometer Log Modified

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

GET /{vin}/trips

Tags: Cars

Retrieves a collection of trips for a specific Car

vin

Vehicle Identification Number

path string
destination

Trip Destination

query string
start_date

When the trip began

query string (date-time)

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Trips satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

Cars

OPTIONS /{vin}/trips

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/trips

Tags: Cars

Create a new trip

Uses default content-types: application/json

The Trip to be added

vin

Vehicle Identification Number

path string

Uses default content-types: application/json

200 OK

Trip Added

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Cars

DELETE /{vin}/trips/{trip_id}

Tags: Cars

Delete a specific Trip

vin

Vehicle Identification Number

path string
trip_id

Trip Identification Number

path string

Uses default content-types: application/json

204 No Content

Trip successfully removed

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

Cars

GET /{vin}/trips/{trip_id}

Tags: Cars

Retrieves a specific Trip

vin

Vehicle Identification Number

path string
trip_id

Trip Identification Number

path string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

404 Not Found

No Trips satisfy the request - the collection is empty

Cars

OPTIONS /{vin}/trips/{trip_id}

Tags: Cars

What can this endpoint do?

vin

Vehicle Identification Number

path string
trip_id

Trip Identification Number

path string

Uses default content-types: application/json

200 OK

Supported HTTP Methods

400 Bad Request

Invalid Request - unable to interpret request

Cars

PUT /{vin}/trips/{trip_id}

Tags: Cars

Modify a specific Trip

Uses default content-types: application/json

The Trip to be modified

vin

Vehicle Identification Number

path string
trip_id

Trip Identification Number

path string

Uses default content-types: application/json

200 OK

Trip Modified

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Request Body conflicts or is malformed

Parameter definitions

alwaysUsedParameter always

You can reference this parameter definition from inside any path parameter definition

query integer (int32)

Schema definitions

basic: object

Car Basic Item

links: object

Hypermedia Links that impact an item in the Cars collection

tutorial4-cars.info: link
tutorial4-cars.modify: link
tutorial4-cars.sell: link
tutorial4-cars.delete: link
tutorial4-owners.info: link
vin: vin
plate_state: platestate
plate_number: platenumber
vehicle_type: vehicletype
vehicle_year: vehicleyear
make: make
model: model
color: color
owner_id: ownerid
owner_name: ownername
created_by_id: createdbyid
created_date_time: createddatetime
updated_by_id: updatedbyid
updated_date_time: updateddatetime

car: object

Car Item

basic: basic
odometer_logs: odometerlogs
trips: trips
insurance_policies: insurancepolicies
maintenance_logs: maintenancelogs

cars: object

A collection of Cars

{
"basic": {
"color": {
"api_type": "modifiable",
"display_label": "Color",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/color",
"value": "Dark Green"
}
,
"created_by_id": {
"api_type": "system",
"description": "Daffy Duck",
"value": "586586586"
}
,
"created_date_time": {
"api_type": "system",
"value": "2014-05-11T13:45:53.09Z"
}
,
"links": {
"cars__delete": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "DELETE",
"rel": "cars__delete",
"title": "cars__deleteCar"
}
,
"cars__info": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "GET",
"rel": "self",
"title": "cars__getCar"
}
,
"cars__modify": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962",
"method": "PUT",
"rel": "cars__modify",
"title": "cars__modifyCar"
}
,
"cars__sell": {
"href": "https://api.byu.edu/domains/tutorials/cars/1FTBE14A4NP05962/salereceipts",
"method": "POST",
"rel": "cars__sell",
"title": "cars__sellCar"
}
,
"owners__info": {
"href": "https://api.byu.edu/domains/tutorials/owners/783783783",
"method": "GET",
"rel": "owners__info",
"title": "owners__getOwner"
}
}
,
"make": {
"api_type": "modifiable",
"display_label": "Make",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/make",
"value": "Toyota"
}
,
"model": {
"api_type": "modifiable",
"display_label": "Model",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/model/Toyota",
"value": "RAV4"
}
,
"owner_id": {
"api_type": "modifiable",
"value": "783783783"
}
,
"owner_name": {
"api_type": "related",
"related_resource": "tutorial5-owners",
"value": "Daisy Duck"
}
,
"plate_number": {
"api_type": "modifiable",
"display_label": "Licence Plate Number",
"value": "Q580RT"
}
,
"plate_state": {
"api_type": "modifiable",
"description": "Utah",
"display_label": "Licence Plate State",
"domain": "https://api.byu.edu/domains/tutorials/meta/plate_state",
"value": "UT"
}
,
"updated_by_id": {
"api_type": "system",
"description": "Daisy Duck",
"value": "783783783"
}
,
"updated_date_time": {
"api_type": "system",
"value": "2014-09-15T08:12:44.03Z"
}
,
"vehicle_type": {
"api_type": "derived",
"display_label": "Vehicle Type",
"domain": "https://api.byu.edu/domains/tutorials/meta/cars/vehicle-type",
"value": "Truck/SUV"
}
,
"vehicle_year": {
"api_type": "modifiable",
"display_label": "Vehicle Year",
"value": "2013"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
,
"insurance": {
"insurer": {
"api_type": "modifiable",
"display_label": "Insurance Agency",
"value": "GEICO"
}
,
"policy_id": {
"api_type": "modifiable",
"value": "A842B53E41"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
,
"maintenance_logs": [
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "283.45"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "Tune-up"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-06-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000354"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"cost": {
"api_type": "modifiable",
"display_label": "Maintenance Cost",
"value": "152.83"
}
,
"description": {
"api_type": "modifable",
"display_label": "Maintenance Description",
"value": "Oil & Lube"
}
,
"maintenance_date": {
"api_type": "modifiable",
"display_label": "Maintenance Date",
"value": "2013-11-01"
}
,
"maintenance_id": {
"api_type": "modifiable",
"key": true,
"value": "000418"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
,
"odometer_logs": [
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 32459
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-05-11"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 33782
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "586586586"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daffy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-06-08"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"miles": {
"api_type": "modifiable",
"display_label": "something",
"value": 35121
}
,
"read_by_id": {
"api_type": "modifiable",
"display_label": "something",
"value": "783783783"
}
,
"read_by_name": {
"api_type": "related",
"display_label": "something",
"value": "Daisy Duck"
}
,
"read_date": {
"api_type": "modifiable",
"key": true,
"value": "2014-07-12"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
,
"trips": [
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Seattle, Washington"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2012-08-16"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 14826
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2012-08-10"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 10745
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A148"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "Denver, Colorado"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-02-09"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 18144
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-02-04"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 17386
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "C233"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
},
{
"destination": {
"api_type": "modifiable",
"display_label": "Trip Destination",
"value": "San Francisco, California"
}
,
"end_date": {
"api_type": "modifiable",
"display_label": "Trip End Date",
"value": "2013-06-26"
}
,
"end_miles": {
"api_type": "modifiable",
"display_label": "Trip Ending Mileage",
"value": 24193
}
,
"start_date": {
"api_type": "modifiable",
"display_label": "Trip Start Date",
"value": "2013-06-22"
}
,
"start_miles": {
"api_type": "modifiable",
"display_label": "Trip Beginning Mileage",
"value": 22354
}
,
"trip_id": {
"api_type": "modifiable",
"key": true,
"value": "A432"
}
,
"vin": {
"api_type": "modifiable",
"key": true,
"value": "1FTBE14A4NP05962"
}
}
]
}
links: object

Hypermedia Links that impact the entire Cars collection

tutorial4-cars.info: link
tutorial4-cars.create: link
metadata: toplevelmetadata
values: object[]
car

color: object

Color of the Vehicle

value: string
api_type: string , x ∈ { read-only , modifiable }
domain: string (uri)

contexts: object

Contexts

values: object[]

cost: object

Cost of Maintenance

value: string
api_type: string , x ∈ { read-only , modifiable }

createdbyid: object

The ID of the person that created the vehicle entry

value: string (up to 9 chars)
api_type: string , x ∈ { system }
description: string

createddatetime: object

When the vehicle entry was created

value: string (date-time)
api_type: string , x ∈ { system }

defaultfieldsets: object

Default Field Sets

value: string , x ∈ { basic }

description: object

Maintenance Log Description

value: string
api_type: string , x ∈ { read-only , modifiable }

destination: object

Trip Destination

value: string
api_type: string , x ∈ { read-only , modifiable }

enddate: object

When the trip ended

value: string (date-time)
api_type: string , x ∈ { read-only , modifiable }

endmiles: object

Mileage read on odometer at end of trip

value: string
api_type: string , x ∈ { read-only , modifiable }

error: object

Error Information

return_code: integer (int32)
explanation: string
error_data: string

fieldsetsavailable: object

Field Sets Available

value: string , x ∈ { basic , odometer_logs , trips , insurance_policies , maintenance_logs }

fieldsetsreturned: object

Field Sets Returned

value: string , x ∈ { basic , odometer_logs , trips , insurance_policies , maintenance_logs }

insurancepolicies: object

Insurance Policy Item

vin: vin
policy_id: policyid
insurer: insurer

insurer: object

Insurance Agency

value: string
api_type: string , x ∈ { read-only , modifiable }

maintenancedate: object

When the maintenance was done on the Car

value: string (date-time)
api_type: string , x ∈ { read-only , modifiable }

maintenanceid: object

Maintenance Log Identification Number

value: string
api_type: string , x ∈ { read-only , modifiable }
key: boolean

maintenancelog: object

Maintenance Log Item

vin: vin
maintenance_id: maintenanceid
maintenance_date: maintenancedate
description: description
cost: cost

maintenancelogs: object

A collection of Maintenance Logs

values: object[]

make: object

Make of the Vehicle

value: string
api_type: string , x ∈ { read-only , modifiable }
domain: string (uri)

methods: string[]

Supported HTTP Methods

string

mileage: object

Mileage Context

value: string , x ∈ { basic , odometer_logs , trips }

miles: object

Mileage read on odometer

value: string
api_type: string , x ∈ { read-only , modifiable }

model: object

Model of the Vehicle

value: string
api_type: string , x ∈ { read-only , modifiable }
domain: string (uri)

odometerlog: object

Odometer Log Item

vin: vin
read_date: readdate
miles: miles
read_by_id: readbyid
read_by_name: readbyname

odometerlogs: object

A collection of Odometer Logs

values: object[]

ownerid: object

The ID of the owner of the vehicle

value: string (up to 9 chars)
api_type: string , x ∈ { read-only , modifiable }

ownername: object

The name of the owner of the vehicle

value: string
api_type: string , x ∈ { read-only , modifiable , related }
related-resource: string

platenumber: object

License Plate Number

value: string
api_type: string , x ∈ { read-only , modifiable }

platestate: object

License Plate State

value: string (up to 2 chars)
api_type: string , x ∈ { read-only , modifiable }
description: string
domain: string (uri)

policyid: object

Policy Identification Number

value: string
api_type: string , x ∈ { read-only , modifiable }
key: boolean

readbyid: object

The ID of the person that created the odometer log

value: string (up to 9 chars)
api_type: string , x ∈ { read-only , modifiable }

readbyname: object

The name of the person that created the odometer log

value: string
api_type: string , x ∈ { read-only , modifiable , related }
related-resource: string

readdate: object

When the odometer log was created

value: string (date-time)
api_type: string , x ∈ { read-only , modifiable }
key: boolean

startdate: object

When the trip began

value: string (date-time)
api_type: string , x ∈ { read-only , modifiable }

startmiles: object

Mileage read on odometer at beginning of trip

value: string
api_type: string , x ∈ { read-only , modifiable }

toplevelmetadata: object

collection_size: integer , { x ∈ ℤ | x ≥ 0 }
page_start: integer , { x ∈ ℤ | x ≥ 0 }
page_end: integer , { x ∈ ℤ | x ≥ 0 }
page_size: integer , { x ∈ ℤ | x ≥ 0 }
default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
field_sets_returned: object[]
field_sets_available: object[]
default_field_sets: object[]
contexts: object[]

trip: object

Trip Item

vin: vin
trip_id: tripid
destination: destination
start_date: startdate
end_date: enddate
start_miles: startmiles
end_miles: endmiles

tripid: object

Trip Identification Number

value: string
api_type: string , x ∈ { read-only , modifiable }
key: boolean

trips: object

A collection of Trips

values: object[]

updatedbyid: object

The ID of the person that last updated the vehicle entry

value: string (up to 9 chars)
api_type: string , x ∈ { system }
description: string

updateddatetime: object

When the vehicle entry was last updated

value: string (date-time)
api_type: string , x ∈ { system }

vehicletype: object

Type of Vehicle

value: string , x ∈ { Car/Sedan/Coupe , Delivery/Service Truck , Moped/Scooter , Motorcycle , Other , Truck/SUV }
api_type: string , x ∈ { read-only , modifiable , derived }
domain: string (uri)

vehicleyear: object

Model Year of the Vehicle

value: string (up to 4 chars)
api_type: string , x ∈ { read-only , modifiable }

vin: object

Vehicle Identification Number

value: string (up to 16 chars)
api_type: string , x ∈ { read-only , modifiable }
key: boolean
Service Path: 
/domains/tutorial/cars
Domain or University API: 
/domains/tutorial/cars

Community

 

Don't see your question listed here? Ask!