WebAPI

<back to all web services

GetVehicleClasses

A list of all the vehicles classes for transaction categorizing. With out any variables you will receive a list of all the classes.

The following routes are available for this service:
GET/GetVehicleClassesRESTFUL call without the Vehicle class id to get all vehicle classes
POST/GetVehicleClassesRetrieve available vehicle classes by (AccountId and PlatePlan) or (AccountTypeId, PlanCode and PlatePlan

To override the Content-type in your clients 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.

POST /jsv/reply/GetVehicleClasses HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	AccountId: 0,
	PlatePlanId: 0,
	AccountTypeId: 0,
	PlanCode: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	VehicleClasses: 
	[
		{
			CategoryId: 0,
			AxleId: 0,
			Description: String,
			VehicleDescription: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}