Billiecart API

<back to all web services

RegisterCarRequest

Requires Authentication
Requires the role:manager
The following routes are available for this service:
PUT,PATCH/cars/{Id}/register
RegisterCarRequest Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
JurisdictionbodystringNo
NumberbodystringNo
PutPatchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
RegisterCarResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CarformCarNo
Car Parameters:
NameParameterData TypeRequiredDescription
ManufacturerformCarManufacturerNo
PlateformCarLicensePlateNo
OwnerformCarOwnerNo
ManagersformList<CarManager>No
StatusformstringNo
Alteredformbool?No
IdformstringNo
CarManufacturer Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MakeformstringNo
ModelformstringNo
CarLicensePlate Parameters:
NameParameterData TypeRequiredDescription
JurisdictionformstringNo
NumberformstringNo
CarOwner Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
CarManager Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
RegisterCarResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CarformCarNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
	}
}