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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetCitations HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetCitations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <CitationNumber>String</CitationNumber>
  <IsMakeRepresentation>false</IsMakeRepresentation>
  <PlateNumber>String</PlateNumber>
</GetCitations>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCitationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <Citations xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:Citation>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:CitationId>0</d2p1:CitationId>
      <d2p1:CitationNumber>String</d2p1:CitationNumber>
      <d2p1:CitationStatus>Open</d2p1:CitationStatus>
      <d2p1:CitationStatusId>0</d2p1:CitationStatusId>
      <d2p1:Date>0001-01-01T00:00:00</d2p1:Date>
      <d2p1:Direction>String</d2p1:Direction>
      <d2p1:FinancialStatus>String</d2p1:FinancialStatus>
      <d2p1:FineBalance>0</d2p1:FineBalance>
      <d2p1:NoticeStatus>Pending</d2p1:NoticeStatus>
      <d2p1:NoticeStatusId>0</d2p1:NoticeStatusId>
      <d2p1:PlateNumber>String</d2p1:PlateNumber>
      <d2p1:TollBalance>0</d2p1:TollBalance>
      <d2p1:TollFare>0</d2p1:TollFare>
      <d2p1:TotalDue>0</d2p1:TotalDue>
      <d2p1:VehicleId>0</d2p1:VehicleId>
    </d2p1:Citation>
  </Citations>
  <IsLinkedAccount>false</IsLinkedAccount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</GetCitationsResponse>