QueryApp

Parameter

Value

Notes

Dataset*

"on"

The data set code, provided to you by your QueryApp administrator

Lang

"en"
"fr"

English
French (not available for all data sets and may not be available for all resources)

SearchType*

"proximity"
"coverage"

Search for resources by distance
Search for resources that serve a specified community or coordinates

Latitude

43.653225

Float value, required for proximity searches, optional for coverage searches

Longitude

-79.383186

Float value, required for proximity searches, optional for coverage searches

Distance

10

Integer value, required for proximity searches, optional for coverage searches

Communities

"Toronto"
["Toronto", "York", "Peel"]
"Toronto|York|Peel"

Single community
Multiple communities in array format when using JSON
Multiple communities delimited by vertical line
Communities or latitude/longitude coordinate set are required in coverage searches

Search*

"term"
"match"

Keyword searches
Match searches

Term

"keyword"

Keyword / key phrase, required in term searches, use * for all resources, place in quotes for exact match

TermMatch

"Partial"
"Exact"
"Words"
"ExactWords"
"AI"
"NaturalLanguage"

Partial match (default)
Exact term must be present
Words must be present (no partial matches)
Exact words/phrase must be present
Uses AI embedding to match query on taxonomy terms for better results
Natural language search (beta)
-- Only operational with Ontario Data Set with MapIDs = on
-- Can only be used with term + proximity searches
-- SortOrder not currently supported

MatchMode

"field name"

Field to match on, required for match searches, refer to field reference

MatchTerms

["keywords", "keywords"]
"keywords|keywords"

Match these terms to the MatchMode field
Multiple terms in array format when using JSON or delimited by a vertical line

MatchMulti

"and"
"or"

Use a second match where both matches are met
Use a second match where either match is met

MatchMode2

"field name"

Field to match on, required for match searches, refer to field reference

MatchTerms2

["keywords", "keywords"]
"keywords|keywords"

Match these terms to the MatchMode2 field
Multiple terms in array format using JSON or delimited by a vertical line |

SortOrder

"best"
"distance"
"name"

Sort by score
Sort by distance (coordinates must be used)
Sort alphabetically

PageIndex

0

Use 0 for the first page of results, 1 for the second page of results and so forth

PageSize

25

Number of results to retrieve (default 25, maximum 1000)

Fields

"AlternateName"

Include additional fields in the results, comma seperated, refer to field reference

FullRecord

true / 1
false / 0

Return all of the fields available

Parameter

Value

Notes

Languages

"English"
["English", "French"]
"English|French"

Resource provides services in this language
Multiple languages in array format when using JSON
Multiple languages delimited by vertical line |

LanguageMatch

"or"
"and"

Match any of the specified languages
Match all of the specified languages

MinAge

12

Minimum age that resources provide services to

MaxAge

18

Maximum age that resources provide services to

Age

18

Resources that provide services to this specific age
Cannot be used with MinAge and MaxAge

ExtCategory

"extcatname"

Some data sets support external category systems

ExtCategoryCode

"ON"

Use categories from a different data set (use data set code)

RequirePhysicalAddress

1

Retrieve resources with physical addresses/coordinates (ideal for mapping projects)

UpdatedOn

"2020-01-01"

Only retrieve resources updated on or after this specified date (YYYY-MM-DD)

IncludeRecords

"12346788,123456789"

Include additional resources in your results, specify by ResourceAgencyNum comma separated
-- Match searches only

IncludeRecordsMethod

"mix-in"
"score-high"

Include records and mix into results
Include records but score higher (comes up first with sort by "best"

MapIDs

"on"
"off"

Some resources are imported into our system on a regular basis and their ids are reset.
Turning this on will retrieve a static id for these resources (Ontario Data Set only).

These fields can be used with Fields, MatchMode or MatchMode2

All Data Sets
"AlternateName"
"OfficialName"
"ParentAgency"
"RecordOwner"
"UniqueIDPriorSystem"
"MailingAttentionName"
"MailingAddress1"
"MailingAddress2"
"MailingCity"
"MailingStateProvince"
"MailingPostalCode"
"MailingCountry"
"MailingAddressIsPrivate"
"PhysicalAddress1"
"PhysicalAddress2"
"PhysicalCity"
"PhysicalCounty"
"PhysicalCommunity"
"PhysicalStateProvince"
"PhysicalPostalCode"
"PhysicalCountry"
"PhysicalAddressIsPrivate"
"OtherAddress1"
"OtherAddress2"
"OtherCity"
"OtherCounty"
"OtherStateProvince"
"OtherPostalCode"
"OtherCountry"
"Latitude"
"Longitude"
"HoursOfOperation"
"EmailAddressMain"
"WebsiteAddress"
"AgencyStatus"
"AgencyClassification"
"AgencyDescription"
"AgencyDescription_Site"
"SearchHints"
"CoverageArea"
"CoverageAreaText"
"Eligibility"
"EligibilityAdult"
"EligibilityChild"
"EligibilityFamily"
"EligibilityFemale"
"EligibilityMale"
"EligibilityTeen"
"LicenseAccreditation"
"IRSStatus"
"FEIN"
"YearIncorporated"
"AnnualBudgetTotal"
"LegalStatus"
"SourceOfFunds"
"ExcludeFromWebsite"
"ExcludeFromDirectory"
"DisabilitiesAccess"
"PhysicalLocationDescription"
"BusServiceAccess"
"PublicAccessTransportation"
"PaymentMethods"
"FeeStructureSource"
"ApplicationProcess"
"ResourceInfo"
"DocumentsRequired"
"AvailabilityNumberOfTimes"
"AvailabilityFrequency"
"AvailabilityPeriod"
"ServiceNotAlwaysAvailability"
"CapacityType"
"ServiceCapacity"
"NormalWaitTime"
"TemporaryMessage"
"TemporaryMessageAppears"
"TemporaryMessageExpires"
"EnteredOn"
"UpdatedOn"
"MadeInactiveOn"
"HighlightedResource"
"LanguagesOffered"
"LanguagesOfferedList"
"LastVerifiedOn"
"LastVerifiedByName"
"LastVerifiedByTitle"
"LastVerifiedByPhoneNumber"
"LastVerifiedByEmailAddress"
"LastVerificationApprovedBy"
"AvailableForDirectory"
"AvailableForReferral"
"AvailableForResearch"
"PreferredProvider"
"ConnectsToSiteNum"
"ConnectsToProgramNum"
"LanguageOfRecord"
"CurrentWorkflowStepCode"
"VolunteerOpportunities"
"VolunteerDuties"
"IsLinkOnly"
"ProgramAgencyNamePublic"
"SiteAgencyNamePublic"
"Categories"
"TaxonomyTerm"
"TaxonomyTerms"
"TaxonomyTermsNotDeactivated"
"TaxonomyCodes"
"Coverage"
"Hours"

Ontario Data Set
"Custom_Minimum Age"
"Custom_Maximum Age"
"Custom_Code"
"Custom_SINV"
"Custom_Bed Count"
"Custom_ESDCID"
"Custom_Elig by Family Comp"
"Custom_Elig by Gender"
"Custom_Elig by Target Pop"
"Custom_OF Bed Count"
"Custom_Public Comments"
"Custom_Former Names"
"Custom_Headings"
"Custom_Legal Name"
"Custom_Pub Codes"
"Custom_iCarol-managed record"
"Custom_iCarol-completed Record"
"Custom_Last Updated By"
"Custom_Facebook"
"Custom_Instagram"
"Custom_LinkedIn"
"Custom_Twitter"
"Custom_YouTube"

Results are returned in JSON and resemble the following:

{
    "RecordCount": Number of resources returned from your search,
    "Records": [
        {
            "id": Resource ID also known as ResourceAgencyNum,
            "ParentId": The current resource's parent resource ID or agency record ID,
            "PublicName": The public name of the resource,
            "Score": Internally calculated score of the resource to your search,
            "ServiceArea": Array of geographical areas this resource services,
            "Distance": Distance to your search coordinates,
            "Description": Description of the resource,
            "Latitude": Latitude coordinate,
            "Longitude": Longitude coordinate,
            "PhysicalAddressStreet1": Physical street address 1,
            "PhysicalAddressStreet2": Physical street address 2,
            "PhysicalAddressCity": Physical city,
            "PhysicalAddressProvince": Physical province code,
            "PhysicalAddressPostalCode": Physiical postal code,
            "PhysicalAddressCountry": Physical country,
            "MailingAttentionName": Mailing attention mame,
            "MailingAddressStreet1": Mailing address 1,
            "MailingAddressStreet2": Mailing address 2,
            "MailingAddressCity": Mailing city,
            "MailingAddressProvince": Mailing province,
            "MailingAddressPostalCode": Mailing postal code,
            "MailingAddressCountry": Mailing country,
            "PhoneNumbers": Array of phone numbers that include:
                {
                    "Phone": Phone number,
                    "Name": Phone number name,
                    "Description": Phone number description,
                    "Type": Phone number type
                }
            "Website": Web site address,
            "Email": Email address,
            "Hours": Hours of operation,
            "Hours2": Hours of operation supplementary (there are two hours field due to the nature of our source database),
            "MinAge": Minimum age*,
            "MaxAge": Maximum age*,
            "UpdatedOn": Date this record was last updated on,
            "RecordOwner": The owner and maintainer of this record*
        }
    ]
}

* These fields may not be present in all data sets

When searching by keywords, resources are given a score based on various factors (this is subject to change at anytime as we are regularly improving this algorithm). The "best" sortorder uses the score to order records.

Base score is 50
Scores are adjusted after the initial query therefore order of results can change when a different PageSize is used
Score adjustments change based on the TermMatch method
Score receives a larger increase for match in the PublicName field
Score receives a moderate increase for match in the AlternateName or TaxonomyTerms field
Score receives a small increase for match in AgencyDescription field
Score receives a moderate increase when multiple words are used as search terms and matches partially or completely in the PublicName field
Score receives a small increase when multiple words are used as search terms and matches verbatim in AgencyDescription field
Score receives a small increase if the search terms are found multiple times in the AgencyDescription
Additional scoring adjustments are made when multiple words are used in the search terms depending on how many match in the PublicName field. Scores will be decreased if the ration of search words to found words is less than 50%
If you were to filter out low scoring records the ideal threshold would be around 40-45

Search for resources within a proximity of a specified location using a keyword.

In this example we are searching for the term "food bank" within 10km of the coordinates for the City of Thunder Bay.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "food bank"
}

SearchType is set to "proximity"
Latitude, Longitude and Distance must be provided in proximity searches and are numeric values
Search is set to "term" for keyword searches
Term is required for keyword searches and is set to "food bank"

Search for resources within a proximity of a specified location that match specific criteria.

In this example we are searching using "Pharmacies" in the Taxonomy Terms field within 10km of the coordinates for the City of Thunder Bay.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Pharmacies"
}

SearchType is set to "proximity"
Latitude, Longitude and Distance must be provided in proximity searches and are numeric values
Search is set to "match" for match searches
MatchMode is required in match searches and set to "taxterm"
MatchTerms is required in match searches and set to "Pharmacies"
MatchMode can be "headings", "category", "pubcodes", "taxcodes", "taxterm", "taxterms", "all" or an iCarol supported field name
Please consult with your QueryApp contact for best use cases
- "headings", "pubcodes" and "categories" are an internal categorization method
- "taxcodes" corresponds the actual taxonomy codes (TJ-3000.1500; TJ-3000.8500)
- "taxterm" corresponds to taxonomy terms (Comprehensive Information and Referral; 211 Systems;)
- "taxterms" corresponds to taxonomy terms that include the parent term (Organizational/Community/International Services - Information Services - Information and Referral - Comprehensive Information and Referral; )
- Using MatchMode as "all" will find all the resources in the specified search area and the MatchTerms parameter is not required when "all" is used

In this example we are using a second match by searching for resources with the Taxonomy Term "Food Bank" and the Taxonomy Term "Food Donation Programs" within 10km of the coordinates for the City of Thunder Bay.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Food Bank",
    "MatchMulti": "and",
    "MatchMode2": "taxterm",
    "MatchTerms2": "Food Donation Programs",
    "Fields": "TaxonomyTerm"
}

MatchMulti can be used to use a second match within your search and is set to either "and" or "or"
MatchMode2 is the field to search within for the second match
MatchTerms2 are the terms to search within for the second field, multiple terms can be delimited with a vertical line |

Search for resources that provides services to a geographical area using a keyword.

In this example we are using a keyword search for "food bank" with coordinates located in the City of Thunder Bay. When coordinates are used the API will try to identify the closest coverage area (there are cases when coordinates will match to a neighbouring coverage area depending on the boundaries).

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Search": "term",
    "Term": "food bank"
}

SearchType is set to "coverage"
Latitude and Longitude are numeric values
Distance is optional, if omitted all resources serving the specified coverage area are returned
Search is set to "term" for keyword searches
Term is required for keyword searches and is set to "food bank"
Resources are sorted by score by default (see last example for sorting by distance)

In this example we using a keyword search for "food bank" that services the communities of Terrace Bay and Nipigon. Multiple communities can be delimited by a vertical line |. Communities must coincide with our community tables otherwise an error is returned.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Communities": "Terrace Bay|Nipigon",
    "Search": "term",
    "Term": "food bank"
}

In this example we are using a keyword search for "food bank" with coordinates serving the City of Thunder Bay and are located within 10km of the coordinates we provided. Only when providing coordinates in coverage area searches can sort the resources by distance.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Communities": "Thunder Bay",
    "Distance": 10,
    "Search": "term",
    "Term": "food bank",
    "SortOrder": "distance"
}

Search for resources that provides services to a geographical area that match specific criteria.

In this example we are searching for the "Pharmacies" using the Taxonomy Terms with coordinates in the City of Thunder Bay. When coordinates are used the API will try to identify the closest coverage area (there are cases when coordinates will match to a neigbouring coverage area depending on the boundaries).

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Pharmacies"
}

SearchType is set to "coverage"
Latitude and Longitude must be provided in proximity searches and are numeric values
Distance is optional, if omitted all resources serving the specified coverage area are returned
Search is set to "match" for match searches
MatchMode is required in match searches and set to "taxterm"
MatchTerms is required in match searches and set to "Pharmacies", multiple terms can be delimited by a vertical line | and the API will match resources with any of the terms provided
MatchMode can be "headings", "category", "pubcodes", "taxcodes", "taxterm", "taxterms", "all" or an iCarol supported field name
Please consult with your QueryApp contact for best use cases
- "headings", "pubcodes" and "categories" are an internal categorization method
- "taxcodes" corresponds the actual taxonomy codes (TJ-3000.1500; TJ-3000.8500)
- "taxterm" corresponds to taxonomy terms (Comprehensive Information and Referral; 211 Systems;)
- "taxterms" corresponds to taxonomy terms that include the parent term (Organizational/Community/International Services - Information Services - Information and Referral - Comprehensive Information and Referral; )
- In the above example, using MatchMode as "all" will find all the resources in that search area (within 10km of Thunder Bay) and the MatchTerms parameter is not required when "all" is used
Resources are sorted alphabetically by default (see last example for sorting by distance)

In this example we are searching for the "Pharmacies" using the Taxonomy Terms that service the communities of Terrace Bay and Nipigon. Multiple communities can be delimited by a vertical line |. Communities must coincide with our community tables otherwise an error is returned.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Communities": "Terrace Bay|Nipigon",
    "Distance": 10,
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Pharmacies"
}

In this example we are searching for the "Pharmacies" using the Taxonomy Terms that service the communities of Thunder Bay and Thunder Bay, Unorganized. By providing coordinates we can sort the resources by distance.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Communities": "Thunder Bay|Thunder Bay, Unorganized",
    "Distance": 10,
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Pharmacies",
    "SortOrder": "distance"
}

In this example we are using a second match and searching for resources with the Taxonomy Term "Food Bank" and the Taxonomy Term "Food Donation Programs" that service the City of Thunder Bay.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "coverage",
    "Communities": "Thunder Bay",
    "Search": "match",
    "MatchMode": "taxterm",
    "MatchTerms": "Food Bank",
    "MatchMulti": "and",
    "MatchMode2": "taxterm",
    "MatchTerms2": "Food Donation Programs",
    "Fields": "TaxonomyTerm"
}

MatchMulti can be used to use a second match within your search and is set to either "and" or "or"
MatchMode2 is the field to search within for the second match
MatchTerms2 are the terms to search within for the second field, multiple terms can be delimited with a vertical line |

To change the number of results and page of results the PageIndex and PageSize parameters are added to the query.

In this example we are searching for all resources located with 10km of Thunder Bay and displaying the first 50 results.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "*",
    "PageIndex": 0,
    "PageSize": 50
}

PageIndex starts at 0 for the first page, 1 would be the second page of results and so forth
PageIndex and PageSize are numeric values

To change the order of the results, the SortOrder parameter is added to the query.

In this example we are searching for all resources located with 10km of Thunder Bay and displaying the first 50 results sorted alphabetically.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "*",
    "PageIndex": 0,
    "PageSize": 50,
    "SortOrder": "name"
}

SortOrder parameter can be set to "best" to sort by score (default), "distance" to sort by proximity or "name" to sort alphabetically.

Search for resources that provide services in a specific language.

In this example we are searching for the term "food" within 10km of the coordinates for the City of Thunder Bay that provide services in French.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "food",
    "Languages": ["French"]
}

Languages are provided in array format

In this example we are searching for all resources within 25km of the coordinates for the City of Thunder Bay that provide services in French and Spanish.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 25,
    "Search": "term",
    "Term": "*",
    "Languages": ["French", "Spanish"],
    "LanguageMatch": "and"
}

Search for resources that provide services to a specific age / age range.

In this example we are searching using the term "Crisis Support" for resources that have a minimum age requirement of 16 or older and a maximum age requirement of 19 or less.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "Crisis Support",
    "MinAge": 16,
    "MaxAge": 19
}

MinAge and MaxAge are numeric values. Can be used individually or together.

In this example we are searching using the term "Crisis Support" for resources that provide services to 18 year olds.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "term",
    "Term": "Crisis Support",
    "Age": 18
}

Age must be a numeric value. Cannot be used with MinAge and MaxAge

Some data sets support external categories. Your QueryApp administrator can provide you with details.

In this example we are displaying all results within the external category "Test" located within 10km of the coordinates we provided.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 100,
    "Search": "match",
    "MatchMode": "all",
    "ExtCategory": "Test"
}

Request only resources that have a physical address, ideal for mapping projects.

In this example we are displaying all results with a physical address located within 10km of the coordinates we provided.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 100,
    "Search": "match",
    "MatchMode": "all",
    "RequirePhysicalAddress": 1
}

Request only resources that have been updated since a specific date.

In this example we are searching for all resources updated since the 2020-12-01 located within 10km of the coordinates we provided.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 100,
    "Search": "match",
    "MatchMode": "all",
    "UpdatedOn": "2020-12-01"
}

UpdatedOn must be in the format YYYY-MM-DD

Request additional fields in your query.

Using the Fields parameter we can retrieve additional fields in the results

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "match",
    "MatchMode": "all",
    "Fields": "UpdatedOn,TaxonomyTerms"
}

Specific resources can be included in the results of match searches (not available in keyword searches)

In this example we are searching using the taxonomy term "food bank" with coordinates of the City of Thunder Bay. Using the IncludeRecords parameter we can add additional resources to the top of the search results.

{
    "Dataset": "on",
    "Lang": "en",
    "SearchType": "proximity",
    "Latitude": 48.461312,
    "Longitude": -89.228477,
    "Distance": 10,
    "Search": "match",
    "MatchMode": "TaxonomyTerm",
    "MatchTerms": "food bank",
    "IncludeRecords": "65303538,65303540",
    "IncludeRecordsMethod": "score-high"
}

IncludeRecords are the resource ids (ResourceAgencyNum) comma separated
IncludeRecordsMethod can be set to "score-high" or "mix-in" depending on how you want the results to be sorted

API v2 - Record Searching

Examples

Search Types

Paging and Sorting Results

Additional Filters