CDS Endpoints

Returns Curb Policies associated with zones in the specified geographic region.

GETyzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies

Query parameters

Response

200400

A successful response containing Curb Zones.

Request

JavaScriptCurlPython

const response = await fetch('yzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies?curbiq_token=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Nearest Policy API - GET policies from position

Get policies that match certain criteria near a position. This API helps solve the classic curbside issue. If you are heading to a destination and want to know where you can complete your curbside activity, whether it is parking, loading, or drop off, use this API to find the closest curb zone to your destination that meets your needs for your given time of arrival.

GETyzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies

Query parameters

Response

200400

A successful response containing Curb Zones.

Body

application/json

typestring

Example: "curbiq_api_response"

request_typestring

Example: "nearest_zones"

query_parametersobject

responsesarray of object

Request

JavaScriptCurlPython

const response = await fetch('yzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies?curbiq_token=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "type": "curbiq_api_response",
  "request_type": "nearest_zones",
  "query_parameters": {
    "coordinates": [
      53.3402,
      -6.2642
    ],
    "zones_requested": 3,
    "activity": "loading",
    "day": "mon",
    "time": "15:00"
  },
  "responses": [
    {
      "distance": {
        "distance": 165,
        "distance_unit": "metres"
      },
      "zone": {
        "curb_zone_id": "cf203cf6-7b59-4e15-8ac9-b47db0859fb3",
        "city_id": "7010923a-7669-4980-aebe-057c656a7574",
        "segment_id": "611.1",
        "geometry": {
          "type": "MultiLineString",
          "coordinates": [
            [
              -6.265687802,
              53.339992418
            ],
            [
              -6.265675022,
              53.340052566
            ]
          ]
        },
        "published_date": 1682629975522,
        "last_updated_date": 1682629975522,
        "start_date": 1682629975522,
        "user_zone_id": "1862",
        "street_name": "AUNGIER STREET",
        "parking_angle": "parallel",
        "num_spaces": 1,
        "policies": [
          {
            "curb_policy_id": "1c75c580-c7f2-4e3c-9f61-aa6736d278c7",
            "regulation_id": 100572,
            "published_date": 1682631261420,
            "priority": 509,
            "rules": [
              {
                "rule_id": "7bb5cbc8-ecc8-48ab-9950-84950b8b8e01",
                "curb_policy_id": "1c75c580-c7f2-4e3c-9f61-aa6736d278c7",
                "activity": "loading",
                "max_stay_unit": "minute",
                "no_return": 0,
                "no_return_unit": "minute",
                "user_classes": [
                  "bus"
                ],
                "rates": [
                  {
                    "rate_id": "cf22c90d-910c-4339-926d-b599463ec2d6",
                    "rule_id": "7bb5cbc8-ecc8-48ab-9950-84950b8b8e01",
                    "rate": 0,
                    "rate_unit": "hour",
                    "rate_unit_period": "rolling"
                  }
                ]
              }
            ],
            "timespans": [
              {
                "timespan_id": "0d46674b-ad1e-4b91-bef7-92c1eaee688b",
                "curb_policy_id": "1c75c580-c7f2-4e3c-9f61-aa6736d278c7",
                "days_of_week": [
                  "mon",
                  "tue",
                  "wed",
                  "thu",
                  "fri",
                  "sat",
                  "sun"
                ],
                "time_of_day_start": "00:00",
                "time_of_day_end": "23:59"
              }
            ]
          }
        ]
      }
    }
  ]
}

Returns Curb Policies associated with zones in the specified geographic region based on the UUID.

FETCHyzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies/{curb_policy_id}

Path parameters

curb_policy_id*string

The unique identifier for the Curb Policy.

Query parameters

Response

200400

A successful response containing Curb Zones.

Request

JavaScriptCurlPython

const response = await fetch('yzij4d8qel.execute-api.ca-central-1.amazonaws.com/v1/curbs/policies/{curb_policy_id}?curbiq_token=text', {
    method: 'FETCH',
    headers: {},
});
const data = await response.json();