ClearPath REST API

This page is a reference guide to ClearPath API 1.0.

You access a resource by sending an HTTP request to the ClearPath API server. The server replies with a response that either contains the data you requested, or a status indicator, or both.

All production environment resources are located at: http://api1.chicagopolice.org/clearpath/api/1.0

You request a particular resource by appending a particular path to this base URL that specifies the resource.

The Production API is currently in Pre-Production mode. While in pre-production mode, submitted information (such as Crime Tips and Community Concerns) will not be routed through for police action.

List of API Calls

  • Crime Tips API Calls
    • Create Crime Tip
    • Upload Image for Crime Tip
  • Crimes API Calls
    • Crime Categories
    • By Major Crimes
    • Crimes Near XY Coordinates
    • By Record Division Number
    • By Type of Crime
    • List of all Crimes
  • Mugshot API Calls
    • By Warrant Number
    • Display Mugshot
  • Most Wanted API Calls
    • List of Most Wanted Individuals
  • Community Events Calendar API Calls
    • Get Community Events
    • Get Community Events Calendars

Authentication and API Token

An API Token is required to use the ClearPath REST API for POST operations only. An API Token will be provided to each user.

Parameter NameValueDescription

apiToken

Required

API Token string similar to the following:

c0b1e556d742f38cb59746cbddc6390526b5bbb5ea58421ae1bb12d5da6f0fac

An API Token that is required for all POST operation calls.

Time Zone

The time zone setting used in the application is GMT (Europe/London). This is done to match the database setting, which is set to GMT, and will allow for accurate date/time calculations.


Crime Tips API Calls

These API Calls are intended to supplement the web functionality accessible at http://tip.chicagopolice.org for submitting a crime tip to the Chicago Police's CPIC (Crime Prevention & Information Center).

Standard Response Format

JSON


Create Crime Tip

Creates an entry in the system for a Community Concern.

Response Fields

Name Description
(All fields of the Tip object that was saved)

The Tip object that was saved, including all fields that were passed in as parameters as well as the concernId, pinNumber and publicResponse.

The concernId is then be used by the image upload call to associate images to a previously loaded crime tip.

Images cannot be uploaded without a valid concernId.

A concernId as well as a pinNumber are generated by the application automatically for each crime tip.

The publicResponse is used to communicate back to the person submitting the crime tip about the status of the crime tip and/or any action taken.

Resource URL

HTTP Method URL Content Type
POST http://api1.chicagopolice.org/clearpath/api/1.0/tips application/x-www-form-urlencoded

Parameters

Name Description Field Length Constraints/Validations

apiToken

Required

An active apiToken.n/a - system generatedn/a - system generated

iSaw

Optional

Overall short description of crime tip.1000 charsNone

recurringEvent

Optional

If this is a recurring event indicate either "yes" or "no."n/an/a

whatHappenedDetails

Optional

Longer narrative details describing the crime tip.1000 charsNone

timeOfDayHour

Optional

The time of day hour (format is: HH).

2 digits

Range: 1 thru 12

If timeOfDayHour, timeOfDayMinutes or ampm is provided, all three parameters are required.

timeOfDayMinutes

Optional

The time of day minutes (format is: MM).

2 digits

Range: 0 thru 59

If timeOfDayHour, timeOfDayMinutes or ampm is provided, all three parameters are required.

ampm

Optional

The 12-hour clock morning or afternoon.

2 chars

"AM" or "PM" are the only valid entries.

If timeOfDayHour, timeOfDayMinutes or ampm is provided, all three parameters are required.

mapAddress

Optional

The address where event occurred.50 charsNone

mapLat

Optional

Latitude value of event's occurrence location.A signed Double numberNone

mapLng

Optional

Longitude value of event's occurrence location.A signed Double numberNone

additionalDetails

Optional

Supplementary description information regarding the crime tip.1000 charsNone

personInvolvedRace

Optional

Race of person involved.

n/a

Parameter limited to one of these codes:

AMERICAN INDIAN

ASIAN

BLACK

UNKNOWN

WHITE

personInvolvedGender

Optional

Gender of person involved.

n/a

Parameter limited to one of these codes:

FEMALE

MALE

personInvolvedAge

Optional

Age of person involved.n/aRange: 0 thru 120

personInvolvedHeight

Optional

Height of person involved (example: 6 foot 2 inches is "602").

n/a

Range: 100 thru 911

Last two digits must be less than 11.

personInvolvedBuild

Optional

Body build of person involved.

n/a

Parameter limited to one of these codes:

HEAVY

MEDIUM

SLENDER

THIN

personInvolvedEyeColor

Optional

Eye color of person involved.

n/a

Parameter limited to one of these codes:

BLACK

BLUE

BROWN

GRAY

GREEN

HAZEL

MAROON

MULTICOLORED

PINK

UNKNOWN

personInvolvedHairColor

Optional

Hair color of person involved.

n/a

Parameter limited to one of these codes:

BLACK

BLOND OR STRAWBERRY

BLUE

BROWN

GRAY OR PARTIALLY GRAY

GREEN

ORANGE

PINK

PURPLE

RED OR AUBURN

SANDY

UNKNOWN OR COMPLETELY BALD

WHITE

personInvolvedDescription

Optional

Description information of the person involved.1000 charsNone

personInvolvedName

Optional

Name of person involved.100 charsNone

personInvolvedAlias

Optional

Alias name of person involved.100 charsNone

vehicleInvolvedVesselType

Optional

Type of vessel (in most cases this will simply be "ROAD").

n/a

Parameter limited to one of these codes:

ROAD

AIRCRAFT

VESSEL

vehicleInvolvedType

Optional


Type of vehicle.

n/a

Parameter limited to one of these codes:

SUV

SEDAN

WAGON

HATCHBACK

COUPE

CONVERTIBLE

PICKUP

CROSSOVER

VAN/MINIVAN

vehicleInvolvedMake

Optional

Make of vehicle (example: Ford).

50 charsNone

vehicleInvolvedModel

Optional

Model of vehicle (example: Mustang).

50 charsNone

vehicleInvolvedRegState

Optional

License plate state of vehicle.

2 chars

Parameter limited to one of these codes:

2-letter state code for all 50 states (i.e. CA, NY, etc.)

DC for District of Columbia

vehicleInvolvedYear

Optional

Year of vehicle.

4 digits

Range: 1900 thru (current year + 1 year)

Upper boundary of range is rolling and takes into account the current year.

"Current year + 1 year" allows for new models introduced in September/October, so a 2014 model car could be on the streets in 2013.

vehicleInvolvedColor

Optional

Color of vehicle.

20 charsNone

vehicleInvolvedLicenseNo

Optional

License plate number (Note: May be a partial plate).20 charsRequired if vehicleInvolvedPartialPlate is provided.

vehicleInvolvedAddlInfo

Optional

Additional information describing the vehicle.1000 charsNone

vehicleInvolvedPartialPlate

Optional

If the license plate entry is not fully complete (indicate "yes" or "no).n/aNone.

vehiclesInvolvedCount

Optional

Total number of vehicles involved.n/aNone

personalInfoReporterName

Optional

Name of person creating the report (Note: A crime tip may be anonymously submitted).n/aA number greater than 0.

personalInfoPhoneNo

Optional

Phone number of person creating the report (Note: A crime tip may be anonymously submitted).50 charsNone

personalInfoEmail

Optional

Email address of person creating the report (Note: A crime tip may be anonymously submitted).50 charsA valid email address format.

personalInfoAddress

Optional

Address of person creating the report (Note: A crime tip may be anonymously submitted).50 charsNone

personalInfoAddress2

Optional

Second line of address for the person creating the report (Note: A crime tip may be anonymously submitted).50 charsNone

personalInfoCity

Optional

City of person creating the report (Note: A crime tip may be anonymously submitted).50 charsNone

personalInfoState

Optional

State of person creating the report (Note: A crime tip may be anonymously submitted).2 chars

Parameter limited to one of these codes:

2-letter state code for all 50 states (i.e. CA, NY, etc.)

DC for District of Columbia

personalInfoZipCode

Optional

Zip code of person creating the report (Note: A crime tip may be anonymously submitted).10 charsNone

Upload Image for Crime Tip

Uploads an image in the system to be used in a report after submitting the Crime Tip report.

Resource URL

HTTP Method URL Content Type
POSThttp://api1.chicagopolice.org/clearpath/api/1.0/image/upload multipart/form-data

Parameters

Name Description Field Length Constraints/Validations

apiToken

Required

An active apiToken.n/a - system generatedn/a - system generated

imageFile

Required

The image being uploaded. This must include the full path to the file being uploaded.n/aFile must be less than 1MB.

concernId

Required

The concernId of a previously submitted crime tip. This will associate this image with a previously submitted crime tip.

n/aMust be a valid concernId.

reporterName

Optional

Name of person creating the report (Note: A crime tip may be anonymously submitted).50 charsNone

description

Optional

Description details of the attachment.1000 charsNone

Response Format

JSON

Response Fields

Name Description
(All fields of the Image object that was saved)

The Image object that was saved.


Get Crime Tip

Retrieves a previously submitted crime tip, including the public response.

Resource URL

HTTP Method URL
GET http://api1.chicagopolice.org/clearpath/api/1.0/tips

Parameters

Name Description

concernId

Required

The concernId automatically generated by the system for a specific crime tip submission.

pinNumber

Required

The Pin Number automatically generated by the system for a specific crime tip submission.

Response Format

JSON

Response Fields

Name Description
(All fields of the Tip object that was saved)

The Tip object that was saved.


Crimes API Calls

Standard Query Parameters

These parameters can be used on all Crimes API GET calls except the following:

  • Crime Categories

Some parameters are implicit if not specified.

NameValueDescription

dateOccurred

Optional

A date the incident occurred.

The date the incident occurred in the format mm-dd-yyyy. The date provided must be > 7 days older than the current date. If the date provided is <= 7 days from the current date, it will be ignored.

Note: If dateOccurred parameter is specified, dateOccurredStart and dateOccurredEnd parameters are ignored.

dateOccurredStart

Optional

A start range of the date the incident occurred.

The start range of the date the incident occurred in the format mm-dd-yyyy. Can be used with or without dateOccurredEnd parameter. The date provided must be > 7 days older than the current date. If the date provided is <= 7 days from the current date, it will be ignored.

Note: If dateOccurred parameter is specified, dateOccurredStart and dateOccurredEnd parameters are ignored.

dateOccurredEnd

Optional

A end range of the date the incident occurred.

The end range of the date the incident occurred in the format mm-dd-yyyy. Can be used with or without dateOccurredStart parameter.

Note: If dateOccurred parameter is specified, dateOccurredStart and dateOccurredEnd parameters are ignored.

max

Optional

Maximum results to be returned.

The maximum number of results you’d like to retrieve. If not specified, the number of results returned will be 10. Values above 100 will be ignored and the maximum number of records returned will be 100.

sort

Optional

The field name to sort on. See the list of Response fields below.

A single field to sort on. If not specified, the default order is by dateOccurred in descending order.

order

Optional

“asc” or “desc”

To sort in ascending or descending order. Values other than “asc” or “desc” are ignored. If sort parameter is specified, the default order is ascending. If sort parameter is not specified, dateOccurred will used as the default sorting field and it will be sorted in descending order.

offset

Optional

A numeric value.

The offset from the first result to list results.

This isused for pagination and is often combined with the max parameter. For a typical scenario of showing 10 results per page, offset=10 would be used for the Page 2 pagination button, offset=20 would be used for the Page 3 pagination button, etc.

Standard Response Format

JSON

Response Fields

NameDescription

beat

The Geographic Number assigned to the location where the crime occurred.

block

The block, including street name, where the crime occurred.

rdNo

The Record Division Number of the crime report.

communityArea

The community area where the crime occurred.

dateOccurred

Date the crime occurred.

iucrDescription

The IUCR Description of the crime.

cpdDistrict

The Chicago Police District where the crime occurred.

iucr

Illinois Uniform Crime Reporting (IUCR) codes are four digit codes that law enforcement agencies use to classify criminal incidents when taking individual reports.

Details can be found here: https://data.cityofchicago.org/Public-Safety/Chicago-Police-Department-Illinois-Uniform-Crime-R/c7ck-438e

lastUpdated

Date this information was last updated.

locationDesc

Description of where the crime occurred (i.e. parking lot, street, bar, etc.)

primary

Primary categorization of the crime.

ward

The ward where incident occurred.

xCoordinate

The State Plane x-coordinate representing an east/west point on a map. (please see Crimes Near XY Coordinates section below for information on State Plane coordinates)

yCoordinate

The State Plane y-coordinate representing a north/south point on a map. (please see Crimes Near XY Coordinates section below for information on State Plane coordinates)


By Major Crimes

Retrieves all major crimes. Major crimes are defined as:

  • Assault, Battery, Burglary, Murder, Rape, Robbery

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/crimes/major

Parameters

Use the URL query string method.

NameValueDescription

block

Optional

A block and/or street name.

The street name where the incident occurred. It is case insensitive. The general format for data in the field is: “005XX N DEARBORN ST”. You can search on any portion of that string (i.e. a value of “block=dearborn” will return all incidents that took place on Dearborn St., subject to max results). This is a case insensitive search.


Crimes Nearby XY Coordinates

Retrieves all crimes within a radius of a given set of xCoordinates and yCoordinates.

X,Y coordinates are based on the NAD83 Zone 1201 Illinois East projected coordinate reference system also known as the East Illinois “State Plane” system. The coordinates are expressed in terms of US survey feet instead of latitude and longitude coordinates. Projected Bounds: 710716.3765, 122425.0355, 1227606.6873, 2126194.8191 correspond to WGS84 lat/lon Bounds: -89.2700, 37.0000, -87.5000, 42.5000

The following links provide more information and conversion tools relating to the State Plane coordinate system:

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/crimes/nearbyXY

Parameters

Use the URL query string method.

NameValueDescription

x

Required

The x coordinate (an integer)


This is the x coordinate used by the State Plane system.

y

Required

The y coordinate (an integer)


This is the y coordinate used by the State Plane system.

radius

Optional

An integer representing the distance in feet from the x/y coordinates provided.

This will govern the boundaries of addresses returned in the search by the amount of feet specified by radius. If not specified, the search will cover a 1000 ft. radius from the x/y coordinate. The term radius is used loosely; it is actually a square with the north, south, east and west boundaries pushed out by the amount of feet specified by radius.


By Record Division Number

Retrieves all crimes for a Record Division Number. Supports partial information in the request.

For example:

This retrieves all crimes for Record Division Numbers that contain “814” somewhere in the rdNo field.

http://api1.chicagopolice.org/clearpath/api/1.0/crimes/rdNo?rdNo=814

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/crimes/rdNo

Parameters

Use the URL query string method.

NameValueDescription

rdNo

Required

The Record Division Number, or a portion of it.

This is the Record Division Number associated with the crime. A search can be performed on the exact Record Division Number, in which case a single record is returned. Providing a subset of the Record Division Number will return multiple results that match that criteria. This is a case insensitive search.


By Type of Crime

Retrieves all crimes for specified type of crime. Supports partial information in the request.

For example:

This retrieves all crimes that contain “assault” somewhere in the Primary field.

http://api1.chicagopolice.org/clearpath/api/1.0/crimes/type?primary=assault

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/hackathon/api/1.0/crimes/type

Parameters

Use the URL query string method.

NameValueDescription

type

Required

The type of crime, which maps to the information stored in the Primary response field.

This is the Type of crime to be returned based on a partial match on the Primary Description of the Crime (standard response field PRIMARY). Providing a Type will return multiple results where the Primary field contains the Type parameter. This is a case insensitive search.

Valid Primary Descriptions found in the database are listed below:

ARSON
ASSAULT
BATTERY
BURGLARY
CRIM SEXUAL ASSAULT
CRIMINAL DAMAGE
CRIMINAL TRESPASS
DECEPTIVE PRACTICE
DOMESTIC VIOLENCE
GAMBLING
HOMICIDE
INTERFERE WITH PUBLIC OFFICER
INTERFERENCE WITH PUBLIC OFFICER
INTIMIDATION
KIDNAPPING
LIQUOR LAW VIOLATION
MOTOR VEHICLE THEFT
NARCOTICS
NON-CRIMINAL
NON-CRIMINAL (SUBJECT SPECIFIED)
OBSCENITY
OFFENSE INVOLVING CHILDREN
OFFENSES INVOLVING CHILDREN
OTHER NARCOTIC VIOLATION
OTHER OFFENSE
PROSTITUTION
PUBLIC INDECENCY
PUBLIC PEACE VIOLATION
RITUALISM
ROBBERY
SEX OFFENSE
STALKING
THEFT
WEAPONS VIOLATION


List all Crimes

Retrieves all crimes with no filtering.

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/crimes/list

Parameters

Use the URL query string method.

NameValueDescription

dateOccurred

Optional

A date the incident occurred.

The date the incident occurred in the format mm-dd-yyyy. The date provided must be > 7 days older than the current date. If the date provided is <= 7 days from the current date, it will be ignored.


Mugshot API Calls

Standard Query Parameters

These parameters must be used on all Mugshot API GET calls.

NameValueDescription

warrantNo

Required

The Warrant Number.Note: The Warrant Number can be obtained from the Most Wanted API calls (see below).

Standard Response Format

JSON, Binary

Response Fields

NameDescription

mugshotNo

The mugshot number. 1=Front Facing, 2=Side Facing, 3-6=Scars/marks/tatoos.

image

The mugshot image. It is BASE64 encoded or in binary form, depending on the API call used.


By Warrant Number

Retrieves all mugshots for a given Warrant Number. The images sent back in JSON are BASE64 encoded. An alternative API call is available to stream back images in binary format for use in an HTML page (mugshot/display, see below).

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/mugshots

Parameters

Use the URL query string method.

NameValueDescription

warrantNo

Required

The Warrant No. An exact match is required.

The Warrant Number the mugshots are assigned to.

Display Mugshot

Retrieves a single mugshot for a given Warrant Number. The image sent back is in binary form for use in <img src=> HTML tags. This is meant to be used in a loop with a given Warrant Number.

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/mugshots/display

Parameters

Use the URL query string method.

NameValueDescription

warrantNo

Required

The Warrant Number. An exact match is required.

The Warrant Number with which the mugshot is associated.

mugshotNo

Optional

An integer 1-6

This represents a single mugshot in a collection of mugshots: 1=Front Facing, 2=Side Facing, 3-6=Scars/marks/tatoos.

Example Usage

Below is a snippet of code that retrieves all mugshots in binary form for use in an HTML page with <img> tags.

  <g:each in="${mugshotList}"var="mugshot"status="i">
  <table>
  <tr>
  <td style="width: 100px;">Warrant Number</td>
  <td><b>${warrantNo}</b> - Mugshot No: ${mugshot.typeId}</td>
  </tr>
  <tr>
  <td>&nbsp;</td>
  <td><img src='${createLink(action: "display", params: [warrantNo: warrantNo, mugshotNo: i + 1])}'
  alt="mugshot"
  style="height:250px;"/>
  </td>
  </tr>
  </table>
  <div style="padding-top: 40px;"></div>
  </g:each>

Sample Source Code

The code below demonstrates the following:

  • A call is made to the index method (simulating what would be done externally).
  • With the JSON result set returned from the call, it converts it to a simple ArrayList of Mugshot objects. This then allows the HTML page to iterate over the collection of mugshots and make calls to the displayMugshot method to retrieve a binary stream (a byte array) of images. This is shown in the first code snippet under Example Usage.
  • Note: This code is Java/Groovy, but the manipulation of the returned JSON can be performed in any language.
def sample() {              
def mugshotList = new ArrayList()
def warrantNo = params.warrantNo
withHttp(uri: "http://api1.chicagopolice.org") {
def html = get(path : '/clearpath/api/1.0/mugshots',
query : [warrantNo: warrantNo])

// Convert from a list of JSONObjects to a list of Mugshots
mugshotList = new ArrayList()
JSONArray jsonArray = (JSONArray)html
if (jsonArray != null) {
int len = jsonArray.length()
for (int i=0; i<len; i++){
mugshotList.add(
new Mugshot(image: jsonArray.get(i).getAt("image"),
mugshotNo: jsonArray.get(i).getAt("mugshotNo"))
)
}
}
}
[mugshotList: mugshotList]
}

To see this code in action, make a GET call to the following resource: http://api1.chicagopolice.org/clearpath/api/1.0/mugshots/sample. Remember to pass in the warrantNo.


Most Wanted API Calls

Standard Query Parameters

These parameters can be used on all Most Wanted API GET calls.

NameValueDescription

max

Optional

Maximum results to be returned.

The maximum number of results you’d like to retrieve. If not specified, the number of results returned will be 10. Values above 100 will be ignored and the maximum number of records returned will be 100.

sort

Optional

The field name to sort on. See the list of Response fields below.

A single field to sort on. If not specified, the default order is by effectiveDate in descending order.

order

Optional

“asc” or “desc”

To sort in ascending or descending order. Values other than “asc” or “desc” are ignored. If sort parameter is specified, the default order is ascending. If sort parameter is not specified, effectiveDate will used as the default sorting field and it will be sorted in descending order.

offset

Optional

A numeric value.

The offset from the first result to list results.

This isused for pagination and is often combined with the max parameter. For a typical scenario of showing 10 results per page, offset=10 would be used for the Page 2 pagination button, offset=20 would be used for the Page 3 pagination button, etc.

Standard Response Format

JSON

Response Fields

Name

Description

offenderNameLast, First Name of the Most Wanted Subject.
nickName Nick Name or Alias of the Most Wanted Subject.
sexGender of the Most Wanted Subject.
raceRace of the Most Wanted Subject.
birthDate Birth Date of the Most Wanted Subject if known.
ageAge of the Most Wanted Subject - at the time of warrant creation. Approximate age may be supplied when birth date is not known.
height Height of the Most Wanted Subject in Feet / Inches.
weightWeight of the Most Wanted Subject in Pounds.
buildBuild description of the Most Wanted Subject (e.g. HEAVY, THIN).
complexion Complexion description of the Most Wanted Subject (e.g. LIGHT, MEDIUM BROWN).
eyeColorEye Color of the Most Wanted Subject.
hairColorHair Color of the Most Wanted Subject.
description Description of the offense for which the Subject is wanted.
effectiveDateDate that the subject was placed on the Most Wanted List.
warrantNoArrest Warrant number for the Most Wanted Subject.

List of Most Wanted Individuals

Retrieves all individuals categorized as Most Wanted.

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/mostWanted/list

Parameters

Use the URL query string method.

NameValueDescription

effectiveDate

Optional

A date in the format mm-dd-yyyy.

The date the person became Most Wanted.

district

Optional

A district number.The district number associated with the Most Wanted classification.

Community Events Calendar API Calls

For accessing information from police / community calendars. Events include beat meetings, subcommittee meetings, and other community policing engagements promoted through the CAPS (Chicago Alternative Policing Strategy) program.

Standard Query Parameters

NameValueDescription
None

Standard Response Format

JSON

Get Community Events

Retrieves all Community Events from all Community Events Calendars or within a specific Community Events Calendar.

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/communityCalendar/events

Parameters

Use the URL query string method. Some parameters are implicit if not specified.

NameValueDescription

calendarId

Optional

The calendarId for which to retrieve Community Events from.If not specified, all Community Events are retrieved from all Community Events Calendars. The calendarId, if specified, will limit the search to only a specific Community Event Calendar. The calendarId can be obtained from the /communityEvents/calendars API call (see below).

eventStartDate

Optional

A start range of the date of the event.

The start range of the date of the event in the format mm-dd-yyyy. Can be used with or without eventEndDate parameter.

eventEndDate

Optional

A end range of the date of the event.

The end range of the date the of the event in the format mm-dd-yyyy. Can be used with or without eventStartDate parameter.

sort

Optional

The field name to sort on. See the list of Response fields below.

A single field to sort on. If not specified, the default order is by eventStartDate in descending order.

order

Optional

“asc” or “desc”

To sort in ascending or descending order. Values other than “asc” or “desc” are ignored. If sort parameter is specified, the default order is ascending. If sort parameter is not specified, eventStartDate will used as the default sorting field and it will be sorted in descending order.

offset

Optional

A numeric value.

The offset from the first result to list results.

This isused for pagination and is often combined with the max parameter. For a typical scenario of showing 10 results per page, offset=10 would be used for the Page 2 pagination button, offset=20 would be used for the Page 3 pagination button, etc.

Response Fields

Name

Description

calendarId
eventStartDate
eventEndDate
eventName
eventDetails
eventURL
contactDetails
location
modifiedDate

Get Community Events Calendars

Retrieves all Community Events Calendars.

Resource URL

HTTP MethodURL
GEThttp://api1.chicagopolice.org/clearpath/api/1.0/communityCalendar

Parameters

Use the URL query string method. Some parameters are implicit if not specified.

NameValueDescription

sort

Optional

The field name to sort on. See the list of Response fields below.

A single field to sort on. If not specified, the default order is by name in ascending order.

order

Optional

“asc” or “desc”

To sort in ascending or descending order. Values other than “asc” or “desc” are ignored. If sort parameter is specified, the default order is ascending. If sort parameter is not specified, name will used as the default sorting field and it will be sorted in ascending order.

offset

Optional

A numeric value.

The offset from the first result to list results.

This isused for pagination and is often combined with the max parameter. For a typical scenario of showing 10 results per page, offset=10 would be used for the Page 2 pagination button, offset=20 would be used for the Page 3 pagination button, etc.

Response Fields

NameDescription
calendarId
name
description