API v2 - Agency Detail
Request the full agency record. The Record Detail request will return all of the data in a combined 'service' record, whereas this will provide all of the underlying records that comprise the service records.
GET
https://data.211support.org/api/v2/agency?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 ParentAgencyNum ID returned from the search call.
• Additional fields can be requested and are comma separated.
• MapIDs=on can be used to return static ids (see field reference under Record Searching).
• Format="geojson" can be added to return in GeoJSON
• Source=1 to show iCarol source field for phones/contacts
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_Code"
"Custom_SINV"
"Custom_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_SocialMedia_Name"
"Custom_SocialMedia_URL"
Shelter Fields
"Custom_ESDCID"
"Custom_Elig by Family Comp"
"Custom_Elig by Gender"
"Custom_Elig by Target Pop"
"Custom_OF Bed Count"
Social Media Fields
"Custom_Facebook"
"Custom_Instagram"
"Custom_LinkedIn"
"Custom_Twitter"
"Custom_YouTube"
Results Reference
Results are returned in JSON and resemble the following:
{
"Agency": The agency record (only one)
"Programs": Array of Program records,
"Sites": Array of Site records,
"ProgramAtSites": Array of ProgramAtSite records,
}
Please note that each record provides a piece of the overall 'service'.
Examples
Retrieving an Agency Record
The resource ID can match any ID within the record family (Agency, Program, Site or ProgramAtSite).
Retrieving a Resource (Default)
In this example we are retrieving agency record using a resource ID.
https://data.211support.org/api/v2/agency?key=xxx&id=65303538&dataset=on
Please note that each record in the results provides a piece of the overall 'service' record.
Retrieving a Resource with Additional Fields
In this example we are retrieving agency record using a resource ID and requesting additional fields.
https://data.211support.org/api/v2/detail?key=xxx&id=65303538&dataset=on&fields=UniqueIDPriorSystem,TaxonomyTerm
Please note that each record in the results provides a piece of the overall 'service' record.