WebAPI

<back to all web services

GetCitations

A details of the citation number given. If the plate yields other citations, a list of those citations with their details will return as well.

The following routes are available for this service:
GET/GetCitations/{PlateNumber}/{CitationNumber}Get Citation and Links Citations for PCN Payment.
GET/GetCitations/{PlateNumber}/{CitationNumber}/{IsMakeRepresentation}Get Citation and Links Citations for Make a representation.
Parameters:
NameParameterData TypeRequiredDescription
PlateNumberpathstringYes
CitationNumberpathstringYes
IsMakeRepresentationpathboolNo

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

{
	PlateNumber: String,
	CitationNumber: String,
	IsMakeRepresentation: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Citations: 
	[
		{
			CitationNumber: String,
			CitationStatus: Open,
			CitationStatusId: 0,
			CitationId: 0,
			AccountId: 0,
			Date: 0001-01-01,
			FineBalance: 0,
			TollBalance: 0,
			TollFare: 0,
			TotalDue: 0,
			Direction: String,
			PlateNumber: String,
			VehicleId: 0,
			NoticeStatusId: 0,
			NoticeStatus: Pending,
			FinancialStatus: String
		}
	],
	IsLinkedAccount: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}