WebAPI

<back to all web services

GetVehicles

Retrieves all vehicles associated to the account id.

The following routes are available for this service:
POST/GetVehiclesRESTFUL call with Account id and page size in the URI.

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/GetVehicles HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	AccountId: 0,
	PlateNumber: String,
	PageSize: 0,
	PageNumber: 0,
	Sorting: String,
	DisplayDiscountPlateOnly: False,
	IsApplyPlanToVehicle: False,
	ProgramId: 0
}

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

{
	Vehicles: 
	[
		{
			VehicleId: 0,
			CategoryId: 0,
			AxleCount: 0,
			MakeId: 0,
			MakeCode: String,
			Make: String,
			VehicleClass: 0,
			VehicleColorCode: String,
			Model: String,
			VehicleColor: String,
			Year: 0,
			PlateStateRegion: String,
			PlateCountry: String,
			PlateNumber: String,
			EffectiveDate: 0001-01-01,
			ExpiryDate: 0001-01-01,
			GroupName: String,
			IsTransponderRequested: False,
			TagId: 0,
			TagSerial: String,
			TagStatusId: 0,
			TagStatus: String,
			TagTypeId: 0,
			RegType: String,
			StartDateTime: 0001-01-01,
			PlatePlanId: 0,
			PlatePlanName: String,
			WheelPlanCode: String,
			WheelPlan: String,
			SeatingCapacity: 0,
			BodyCode: String,
			Body: String,
			TaxClassCode: String,
			TaxClassCodeDescription: String,
			PlatePlanStatusId: 0,
			PlatePlanStatusDescription: String,
			IsMonthlyPassAutoRenewal: False,
			ApprovalDocIsInvalid: False,
			MissingDocType: 
			[
				0
			],
			MissingDocTypeDesc: 
			[
				String
			],
			Message: String,
			SetupFee: 0,
			NeedManualRenewal: False,
			NeedManualRenewalLUDS: False,
			IsLUDSAutoRenewal: False
		}
	],
	TotalNumber: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}