POST api/pbp/v2014-06/permits/search

[lalamarre]

Queries the payment provider for permits that match specific search criteria. The query requires a list of plate numbers that will be matched in each provided zone. If a matched permit is present in one of the zones provided, it will be returned.

Request Information

Body Parameters

Request Formats

application/json, text/json
Sample

{
  "PlateNumbers": [
    "ABC123",
    "DEV456"
  ],
  "ZoneIds": [
    "prk1",
    "prk2"
  ]
}

Response Information

Returns a list of permits that match the specified search critera. If no permits were found, error 404 (Not Found) is expected.

Response Formats

application/json, text/json
Sample

{
  "PermitZones": [
    {
      "Permits": [
        {
          "Expiry": "2020-12-07T15:55:01.475935Z",
          "Activation": "0001-01-01T00:00:00",
          "PermitId": "1234A",
          "PlateNumber": "ABC123",
          "PlateState": "NY",
          "Make": "Hyundai",
          "Color": "Green"
        },
        {
          "Expiry": "2020-12-08T15:55:01.475935Z",
          "Activation": "0001-01-01T00:00:00",
          "PermitId": "5678B",
          "PlateNumber": "DEV456",
          "PlateState": "NY",
          "Make": "Honda",
          "Color": "Red"
        }
      ],
      "ZoneId": "prk1"
    },
    {
      "Permits": [
        {
          "Expiry": "2020-12-07T15:55:01.475935Z",
          "Activation": "0001-01-01T00:00:00",
          "PermitId": "1234A",
          "PlateNumber": "ABC123",
          "PlateState": "NY",
          "Make": "Ford",
          "Color": "Black"
        }
      ],
      "ZoneId": "prk2"
    }
  ]
}