Policies
A Policy object sets the rules for how specific users can or cannot use a particular curb at designated times. Each Curb Zone's regulations are defined by a combination of multiple Policy objects. Querying Curb Policies can provide the full set of policies.
The CurbIQ token provided to you when you registered for the API.
CDS
A list of curb policy ids to query, separated by commas.
If present, return only policies with the supplied UUIDs. Otherwise, return all policies.
CCDS
The ID of a Curb Zone.
If specified, only return Curb Policies associated with this zone.
CCDS
Latitude at the center of the search circle for querying policies associated with zones in a bounding box. Required if
'lng' or 'radius' is specified.
CCDS
Longitude at the center of the search circle for querying policies associated with zones in a bounding box. Required if
'lat' or 'radius' is specified.
CCDS
Radius of the search circle (in centimeters). Required if
'lat' or 'lng' is specified.
CCDS
For querying policies associated with zones in a bounding box. If any of min_lat, min_lng, max_lat,
max_lng are specified, all must be.
CCDS
For querying policies associated with zones in a bounding box. If any of min_lat, min_lng, max_lat,
max_lng are specified, all must be.
CCDS
For querying policies associated with zones in a bounding box. If any of min_lat, min_lng, max_lat,
max_lng are specified, all must be.
CCDS
For querying policies associated with zones in a bounding box. If any of min_lat, min_lng, max_lat,
max_lng are specified, all must be.
CCDS
Filter Curb Zones based on validity at this timestamp (in ms).
1643130000000CCDS
Filter by a specific curb policy ID.
CCDS
Max is 250. Default is 100.
CCDS
Page number for paginated results. Default is 1.
A successful response containing Curb Policies.
GET /curbs/policies?curbiq_token=text HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*
A successful response containing Curb Policies.
{
"version": "1.0.1",
"time_zone": "US/Eastern",
"last_updated": 1706043881390,
"currency": "USD",
"author": "CurbIQ",
"licence_url": null,
"ccds_attributes": {
"type": "curbiq_api_response",
"request_type": "policies",
"city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
"city_name": "arlington",
"query_parameters": {
"curb_policy_id": "a31cdc34-e2aa-4706-9c81-680245843203",
"curbiq_token": "curbiq_token"
}
},
"pages": {
"total": 1,
"current": 1
},
"data": [
{
"policies": [
{
"curb_policy_id": "04db9f03-7f4a-4787-8be0-4261b352590c",
"published_date": 1706044048915,
"priority": 509,
"data_source_operator_id": null,
"timespans": [
{
"days_of_week": [
"mon"
],
"months": [
null
],
"days_of_month": [
null
],
"time_of_day_start": "15:00",
"time_of_day_end": "19:00",
"start_date": 1704085200,
"end_date": null,
"designated_period": null
}
],
"rules": [
{
"activity": "no parking",
"max_stay": null,
"max_stay_unit": "minute",
"no_return": null,
"no_return_unit": "minute",
"user_classes": [
null
],
"rate": {
"rate": 0,
"rate_unit": "hour",
"rate_unit_period": "rolling"
}
}
]
}
]
}
]
}The unique identifier for the Curb Policy.
The CurbIQ token provided to you when you registered for the API.
CCDS
Default is 100. The maximum response size is 250.
CCDS
Page number for paginated responses, default is 1.
A successful response containing Curb Policies.
Request failed.
GET /curbs/policies/{curb_policy_id}?curbiq_token=text HTTP/1.1
Host: v2.curbiq-curb-api.io
Accept: */*
{
"version": "1.0.1",
"time_zone": "US/Eastern",
"last_updated": 1706043881390,
"currency": "USD",
"author": "CurbIQ",
"licence_url": null,
"ccds_attributes": {
"type": "curbiq_api_response",
"request_type": "policies",
"city_id": "768bbbf9-1ee2-45da-aafb-a44808461f86",
"city_name": "arlington",
"query_parameters": {
"curb_policy_id": "04db9f03-7f4a-4787-8be0-4261b352590c",
"curbiq_token": "curbiq_token"
}
},
"pages": {
"total": 1,
"current": 1
},
"data": [
{
"policies": [
{
"curb_policy_id": "04db9f03-7f4a-4787-8be0-4261b352590c",
"published_date": 1706044048915,
"priority": 509,
"data_source_operator_id": null,
"timespans": [
{
"days_of_week": [
"mon"
],
"months": [
null
],
"days_of_month": [
null
],
"time_of_day_start": "15:00",
"time_of_day_end": "19:00",
"start_date": "1704085200",
"end_date": null,
"designated_period": null
}
],
"rules": [
{
"activity": "no parking",
"max_stay": null,
"max_stay_unit": "minute",
"no_return": null,
"no_return_unit": "minute",
"user_classes": [
null
],
"rate": {
"rate": 0,
"rate_unit": "hour",
"rate_unit_period": "rolling"
}
}
]
}
]
}
]
}Last updated