GET api/pbp/v2014-06/zones/{zoneId}/permits?continuationToken={continuationToken}

[lalamarre]

Lists all permits for a specified zone.

Request Information

URI Parameters

Response Information

If the continuation token is not specified, the methods returns all active permits for the specified zone. If the token is specified, all permits belonging to the specified zone modified since the last token are returned. If the specified zone is unknown, the service returns error 404 (Not Found). If the payment provider cannot determine permits belonging to a zone (e.g. paystation is defective), error 503 (Service Unavailable) is returned.

Permit Results

Represents the result of a permit query against the payment provider.

Response Formats

application/json, text/json
Sample

{
  "ContinuationToken": "12/6/2020 3:55:01 PM",
  "Permits": [
    {
      "Expiry": "2020-12-07T15:55:01.475935Z",
      "Activation": "0001-01-01T00:00:00",
      "PermitId": "1234A",
      "PlateNumber": "ABC123",
      "PlateState": "NY",
      "Make": "Renault",
      "Color": "Blue"
    },
    {
      "Expiry": "2020-12-08T15:55:01.475935Z",
      "Activation": "0001-01-01T00:00:00",
      "PermitId": "5678B",
      "PlateNumber": "DEV456",
      "PlateState": "NY",
      "Make": "Honda",
      "Color": "White"
    },
    {
      "Expiry": "2020-12-09T15:55:01.475935Z",
      "Activation": "0001-01-01T00:00:00",
      "PermitId": "5678B",
      "PlateNumber": "HJY1AA",
      "PlateState": "CA",
      "Make": "BMW",
      "Color": "Grey"
    }
  ]
}