Services

Last Updated 7/1/2015

The Services API is avialable at http://apps.illinoisworknet.com/Locator/.

NOTE: PhoneSearch and PhoneDetail are different from Search and Location. PhoneSearch and PhoneDetail return limited information about locations and are intended for use when bandwidth is limited, such as for a mobile device. Search and Location return more complete information about locations.

PhoneSearch

    GET api/PhoneSearch/?keyword=keyword
    &zipcode=zipcode
    &latitude=latitude
    &longitude=longitude
    &miles=radius
    &fips=fipsList
    &city=cityName
    &zipcodeList=zipcodeList
    &take=take
    &skip=skip
    &serviceIds=serviceIdList
    &audiencetypeIds=audienceTypeIdList
    &gradeLevelIds=gradeLevelIdList
    &interestIds=interestIdList

Notes:

  1. Either a zipcode+radius, latitude+longitude+radius, a fips code list, a city, or a zipcode list should be specified at minimum (A zipcode list returns locations that are within the list of zipcodes. For example, I could get locations in Peoria and Bloomington by passing a CSV list of Peoria and Bloomington Zipcodes in the zipcodeList parameter). Radius can go with either zipcode or latitude/longitude. All lists are CSV lists, and FIPS code lists are assumed to be Illinois county FIPS codes.
  2. City searches by city name. "E. Peoria" and "East Peoria" are NOT the same thing. Events should be entered with the city names spelled out instead of using abbreviations.
  3. The Grade Levels returned by the GradeLevel GET method return "All" and "Not Applicable." These two values are special. "Not Applicable" exists for validation purposes only, since we require the user to select at least one grade level. It is never stored in the database, so please do not search for it. "All" searches for grades "Pre-Kindergarten" through "Technical." It is not stored in the database either. If you want to search by "All" you should search by all grade levels from "Pre-Kindergarten" through "Technical." Note that this behavior will return different results from leaving the filter blank. Leaving the filter blank will not apply the filter, so you can retrieve locations which do not have a grade level associated with them (this is the "Not Applicable" behavior), while searching for grade levels "Pre-Kindergarten" through "Technical" will not include locations which do not have a grade level associated with them.

PhoneDetail

    GET api/PhoneDetail/id

Returns details about a given location.

Audience

    GET api/Audience/

Returns a list of all audiences.

    GET api/Audience/id

Returns an Audience record whose Id matches id.

FieldOfInterest

    GET api/FieldOfInterest/

Returns all Fields of Interest.

    GET api/FieldOfInterest/id

Returns the field of interest that matches id​.

GradeLevel

    ​GET api/GradeLevel/

Returns all Grade Levels. See notes under PhoneSearch or Search for details on the two special values, "All" and "Not Applicable."

    GET api/GradeLevel/id

Returns the grade level that matches id​.

Service

    GET api/Service/

Returns all Services with their associated Service Categories.

    GET api/Service/id

Returns an individual service that matches id​.

ServiceCategory

    GET api/ServiceCategory/

Returns all service categories with their associated services.

    GET api/ServiceCategory/id

Returns an individual service that matches id.

City

    GET api/City/?city=cityName&state=state&take=take

Returns the first take cities/states that begin with cityName within state. If take is omitted, the default is the first 10. If state is omitted, the states of Illinois, Indiana, Iowa, Kentucky, Missouri, and Wisconsin are searched.