The QueryApp API for Web Portals is used to query and retrieve results from the QueryApp API. Supports keyword searching, topic searching and various other features. Results are returned in JSON.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"9260923","collectionId":"5e3ada8c-804d-41c9-a6c3-55bcf95a0ba9","publishedId":"SVzxYzbS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-25T12:05:42.000Z"},"item":[{"name":"Record Searching","id":"84b09ecc-2608-4ead-a794-9a0e19425227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"term\": \"{{term}}\",\n \"locationText\": \"{{locationText}}\",\n \"locationPoint\": {\n \"latitude\": {{latitude}},\n \"longitude\": {{longitude}}\n },\n \"maxDistanceInKilometers\": {{maxDistanceInKilometers}},\n \"paginationInfo\": {\n \"sortField\": \"{{sortField}}\",\n \"sortOrder\": \"{{sortOrder}}\",\n \"pageIndex\": {{pageIndex}},\n \"pageSize\": {{pageSize}}\n },\n \"lang\": \"{{lang}}\",\n \"ciocRecordOwner\": \"{{ciocRecordOwner}}\",\n \"pubCodes\": \"{{pubCodes}}\",\n \"communities\": \"{{communities}}\",\n \"topicMode\": \"{{topicMode}}\",\n \"topicTerms\": \"{{topicTerms}}\",\n \"topicMulti\": \"{[topicMulti}}\",\n \"topicMode2\": \"{{topicMode2}}\",\n \"topicTerms2\": \"{{topicTerms2}}\",\n \"records\": \"{{records}}\",\n \"recordsSticky\": \"{{recordsSticky}}\",\n \"requirePhysicalAddress\": \"{{requirePhysicalAddress}}\"\n}"},"url":"https://data.211support.org/api/search?key={{api_key}}","description":"Search the QueryApp API using various matching and filtering. Closely resembles the Ontario 211 API configuration for interoperability.
\nterm = Search Terms\nlocationText = Name of the Location - Not Used\nlocationPoint\n latitude = Latitude\n longitude = Longitude\nmaxDistanceInKilometers = Max Distance in Kilometers\npaginationInfo\n sortField = Sort field (string / Distance / Name ) - defaults to string (best match)\n sortOrder = Leave as \"Unspecified\" - currently not used\n pageIndex = Page index of results\n pageSize = Number of results per page\nlang = Language ( en / fr )\nciocRecordOwner = Record owner filtering using CIOC codes (comma separated)\npubCodes = Filter ot publication codes (comma separated)\ncommunities = Only enter values for Area Served searches (comma separated)\ntopicMode = \"headings\", \"category\", \"pubcodes\", \"taxcodes\", \"taxterm\" or \"taxterms\"\ntopicTerms = Matching text separated by vertical line |\ntopicMulti = \"and\", \"or\" or \"\" to match with a second query\ntopicMode2 = \"headings\", \"category\", \"pubcodes\", \"taxcodes\", \"taxterm\" or \"taxterms\"\ntopicTerms2 = Matching text separated by vertical line |\nrecords = Include specific records in results (topic match searches only)\nrecordsSticky = Include the above records at the top of the results (topic match searches only)\nrequirePhysicalAddress = (0/1) Only return records with a physical address (ideal for mapping purposes)\n\nPlease Note:\n- For topic type searches, leave the term (Search Terms) blank. \n- Only enter communities if you want an area served search.\n- Do not put a space after the commas for comma separated values\nQueryApp API Key
\n","type":"text/plain"},"key":"key","value":"{{api_key}}"}],"variable":[]}},"response":[{"id":"62217c24-7b26-4b69-8b9d-8d45fdcfe7b1","name":"Search for \"lspc\" using coordinates in Thunder Bay","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"term\": \"lspc\",\n \"locationText\": \"{{locationText}}\",\n \"locationPoint\": {\n \"latitude\": 48.380894,\n \"longitude\": -89.247681\n },\n \"maxDistanceInKilometers\": 25,\n \"paginationInfo\": {\n \"sortField\": \"string\",\n \"sortOrder\": \"Unspecified\",\n \"pageIndex\": 0,\n \"pageSize\": 25\n },\n \"lang\": \"en\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://data.211support.org/api/search?key={{api_key}}","protocol":"https","host":["data","211support","org"],"path":["api","search"],"query":[{"key":"key","value":"{{api_key}}","description":"QueryApp API Key"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Oct 2019 12:08:57 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"6748"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"totalCount\": \"5\",\n \"entries\": [\n {\n \"distance\": 0,\n \"topicPath\": \"\",\n \"resourceID\": \"63776208\",\n \"organizationID\": \"63776205\",\n \"resourceName\": \"Lakehead Social Planning Council - 211 Northern Region Contact Centre\",\n \"name\": \"Lakehead Social Planning Council - 211 Northern Region Contact Centre\",\n \"physicalAddress\": \"125 Syndicate Ave S\",\n \"mailingAddress\": \"\",\n \"resourceDescription\": \"Retrieve a single record using the id (ResourceAgencyNum).
\n","urlObject":{"protocol":"https","path":["api","detail"],"host":["data","211support","org"],"query":[{"description":{"content":"QueryApp API Key
\n","type":"text/plain"},"key":"key","value":"{{api_key}}"},{"description":{"content":"Match to ResourceAgencyNum
\n","type":"text/plain"},"key":"id","value":"{{id}}"},{"description":{"content":"or Match to UniqueIDPriorSystem (CIOC ID)
\n","type":"text/plain"},"key":"cioc_id","value":"{{cioc_id}}"},{"description":{"content":"or Match to PublicName
\n","type":"text/plain"},"key":"publicName","value":"{{publicName}}"},{"description":{"content":"Language (en/fr) - Optional
\n","type":"text/plain"},"key":"lang","value":"{{lang}}"}],"variable":[]}},"response":[{"id":"ab1016db-65dd-48b2-a332-6d6101fc69b2","name":"Retrieve record by id (ResourceAgencyNum)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data.211support.org/api/detail?key={{api_key}}&id=63776208&lang=en","protocol":"https","host":["data","211support","org"],"path":["api","detail"],"query":[{"key":"key","value":"{{api_key}}","description":"QueryApp API Key"},{"key":"id","value":"63776208","description":"Match to ResourceAgencyNum"},{"key":"lang","value":"en","description":"Language (en/fr) - Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Oct 2019 12:16:16 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Content-Length","value":"2909"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"resourceName\": \"Lakehead Social Planning Council - 211 Northern Region Contact Centre\",\n \"resourceAgencyNum\": 63776208,\n \"resourceID\": 63776208,\n \"id\": 63776208,\n \"latitude\": \"48.383234\",\n \"longitude\": \"-89.248139\",\n \"topicPath\": \"Comprehensive Information and Referral; 211 Systems; \",\n \"orgTitle\": \"Lakehead Social Planning Council - 211 Northern Region Contact Centre\",\n \"orgDescription\": \"Retrieve a record family using the id (ResourceAgencyNum). The id can correspond to the agency, program, site or programatsite.
\n","urlObject":{"protocol":"https","path":["api","agency"],"host":["data","211support","org"],"query":[{"description":{"content":"QueryApp API Key
\n","type":"text/plain"},"key":"key","value":"{{api_key}}"},{"description":{"content":"Match by ResourceAgencyNum
\n","type":"text/plain"},"key":"id","value":"{{id}}"},{"description":{"content":"or Match by UniqueIDPriorSystem (CIOC ID)
\n","type":"text/plain"},"key":"cioc_id","value":"{{cioc_id}}"},{"description":{"content":"Language (en/fr) - Optional
\n","type":"text/plain"},"key":"lang","value":"{{lang}}"}],"variable":[]}},"response":[{"id":"6de89cb1-5709-49e1-a147-1c31321e3013","name":"Retrieve record family by id (ResourceAgencyNum)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://data.211support.org/api/agency?key={{api_key}}&id=63776205&lang=en","protocol":"https","host":["data","211support","org"],"path":["api","agency"],"query":[{"key":"key","value":"{{api_key}}","description":"QueryApp API Key"},{"key":"id","value":"63776205","description":"Match by ResourceAgencyNum"},{"key":"lang","value":"en","description":"Language (en/fr) - Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 25 Oct 2019 12:17:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"agency\": [\n {\n \"resourceName\": \"Lakehead Social Planning Council\",\n \"resourceAgencyNum\": 63776205,\n \"resourceID\": 63776205,\n \"id\": 63776205,\n \"latitude\": \"48.3817\",\n \"longitude\": \"-89.2455\",\n \"topicPath\": \"\",\n \"orgTitle\": \"Lakehead Social Planning Council\",\n \"orgDescription\": \"Brings people together to develop programs and services for the community\",\n \"eligibility\": \"\",\n \"applicationProcess\": \"\",\n \"hoursOperation\": \"\",\n \"address\": \"\",\n \"mailAddress\": \"\",\n \"physicalAddressDetail\": {\n \"address\": \"125 Syndicate Ave S\",\n \"address_2\": \"Suite 38\",\n \"community\": \"\",\n \"city\": \"Thunder Bay\",\n \"state_code\": \"ON\",\n \"zip_code\": \"P7E 6H8\",\n \"country\": \"Canada\"\n },\n \"mailingAddressDetail\": {\n \"address\": \"\",\n \"address_2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"state_code\": \"\",\n \"zip_code\": \"\",\n \"country\": \"Canada\"\n },\n \"businessPhone\": \"807-624-1720\",\n \"hotline\": \"\",\n \"tollfree\": \"1-877-586-5638\",\n \"fax\": \"807-625-9427\",\n \"afterHoursPhone\": \"\",\n \"tty\": \"\",\n \"legalStatus\": \"(50) Non Profit\",\n \"fee\": \"\",\n \"serviceContactName\": \"Marie Klassen\",\n \"serviceContactTitle\": \"Director of Services\",\n \"serviceContactEmail\": \"mklassen@tbaytel.net\",\n \"serviceContactPhone\": \"807-624-1721\",\n \"serviceArea\": \"\",\n \"updated\": \"2019-10-04 12:30:23\",\n \"disabilitiesAccess\": \"\",\n \"languages\": \"\",\n \"website\": \"www.lspc.ca\",\n \"eMail\": \"info@lspc.ca\",\n \"ciocID\": \"TBY0415\",\n \"recordOwnerName\": \"211 Ontario North\",\n \"PublicName\": \"Lakehead Social Planning Council\",\n \"parentAgencyNum\": 0,\n \"connectsToSiteNum\": 0,\n \"connectsToProgramNum\": 0,\n \"Custom_Headings\": \"\",\n \"TaxonomyCodes\": \"\",\n \"TaxonomyTerm\": \"\",\n \"TaxonomyTerms\": \"\",\n \"PublicComments\": \"\",\n \"CustomFacebook\": \"https://www.facebook.com/211North/\",\n \"CustomInstagram\": \"\",\n \"CustomLinkedIn\": \"\",\n \"CustomTwitter\": \"\",\n \"CustomYouTube\": \"\",\n \"UpdatedOn\": \"2019-10-04 12:30:23\"\n }\n ],\n \"programs\": [\n {\n \"resourceName\": \"211 Northern Region Contact Centre\",\n \"resourceAgencyNum\": 63776207,\n \"resourceID\": 63776207,\n \"id\": 63776207,\n \"latitude\": \"0\",\n \"longitude\": \"0\",\n \"topicPath\": \"Comprehensive Information and Referral; 211 Systems; \",\n \"orgTitle\": \"211 Northern Region Contact Centre\",\n \"orgDescription\": \"