QueryApp

API Documentation

Documentation Home Record Detail

API v2 - Record Detail

Request an individual record.

GET

https://data.211support.org/api/v2/detail?key=xxx&dataset=xxx&lang=xxx&id=xxx&fields=xxx

• A valid API key is required for all requests and is placed in the url.
• A dataset parameter is required for all requests. Typically the province code but can be different for specialized data sets.
• The lang parameter is set to either the English (default: "en") or French ("fr") database. Not all records have associated French or English records.
• The id is the record ID (or ResourceAgencyNum) and should match an ID returned from the search call (or ProgramAtSite internally).
• Additional fields can be requested and are comma separated.
• MapIDs="on" can be used to return static ids (see field reference under Record Searching).

Field Reference

These fields can be used with Fields

All Data Sets
"AlternateName"
"OfficialName"
"ParentAgency"
"RecordOwner"
"UniqueIDPriorSystem"
"MailingAttentionName"
"MailingAddress1"
"MailingAddress2"
"MailingCity"
"MailingStateProvince"
"MailingPostalCode"
"MailingCountry"
"MailingAddressIsPrivate"
"PhysicalAddress1"
"PhysicalAddress2"
"PhysicalCity"
"PhysicalCounty"
"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_SINV"
"Custom_Code"
"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 Reference

Results are returned in JSON and resemble the following:

{
    "id": Resource ID also known as ResourceAgencyNum,
    "ParentId": Resource ID of the parent agency record,
    "PublicName": Resource public name,
    "Score": Internally used score,
    "ServiceArea": Array of areas this resource serves,
    "Description": Resource description (typically html),
    "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),
    "UpdatedOn": Date this resource was last updated",
    "RecordOwner": Owner/maintainer of this resource*,
    "ConnectsToSiteNum": Resource ID of the site record,
    "ConnectsToProgramNum": Resource ID of the program record,
    "Languages": Languages this resource provides services in - open text,
    "LanguagesList":  Languages this resource provides services in, semi-colon seperated values,
    "Eligibility": Eligibility notes,
    "MinAge": Minimum age of people this resource provides services to*,
    "MaxAge": Maximum age of people this resource provides services to*,
    "DisabilitiesAccess": Disability notes,
    "DocumentsRequired": Documents required,
    "Contacts": Array of contacts for this resource that include:
        {
            "Name": Contact name,
            "Title": Contact title,
            "Phone": Contact phone number,
            "Email": Contact email address
        }
    "Facebook": Social media Facebook url*,
    "YouTube": Social media YouTube url*,
    "Instagram": Social media Instagram url*,
    "Twitter": Social media Twitter url*,
    "LinkedIn": Social media LinkedIn url*
}

* These fields may not be present in all data sets

Examples

Retrieving a Resource

The resource ID should always match an id returned in the record searching call (or a ProgramAtSite record ID internally)

Retrieving a Resource (Default)

Retrieving a Resource with Additional Fields