Requires the role: | manager |
PUT,PATCH | /cars/{Id}/register |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
Jurisdiction | body | string | No | |
Number | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrganisationId | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Car | form | Car | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Manufacturer | form | CarManufacturer | No | |
Plate | form | CarLicensePlate | No | |
Owner | form | CarOwner | No | |
Managers | form | List<CarManager> | No | |
Status | form | string | No | |
Altered | form | bool? | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Year | form | int | No | |
Make | form | string | No | |
Model | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Jurisdiction | form | string | No | |
Number | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
Car | form | Car | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /cars/{Id}/register HTTP/1.1
Host: staging-api.billiecart.com.au
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
jurisdiction: String,
number: String,
organisationId: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, car: { manufacturer: { year: 0, make: String, model: String }, plate: { jurisdiction: String, number: String }, owner: { id: String }, managers: [ { id: String } ], status: String, altered: False, id: String } }