{"info":{"_postman_id":"cc50ec59-c1ba-4bbe-ae2d-cb445f957d9e","name":"LetMeHelp API","description":"<html><head></head><body><p>Provides methods for accessing Charities, Locations, and Events.<br></p>\n<p>For now, assuming the responses include all data for the model currently stored in database.</p>\n<h2 id=\"pagination\">Pagination<br></h2>\n<p>In the url, to paginate, specify the <code>offset</code> and the <code>max_results</code> parameters<br>\n<code>max_results</code> is 40 by default<br>\nFor example, if there are 100 results, and a page size of 20, to get the 4th page:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>api.letmehelp.life/charities?q=dogs&amp;offset=60&amp;max_results=20\n</code></pre><h2 id=\"sorting\">Sorting<br></h2>\n<p>In the url, to sort, specify the <code>sort</code> parameter.<br>\nFor example, to sort by ascending city and descending id:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>api.letmehelp.life/charities?q=dogs&amp;sort=city,id:desc\n</code></pre><h2 id=\"range-queries\">Range queries<br></h2>\n<p>Certain parameters can be queried with a range.<br>\nFor example, to get all cities with population between 1 million and 2 million, inclusive:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>api.letmehelp.life/cities?population=1000000-2000000\n</code></pre><p>Currently, there will only be support for inclusive queries.</p>\n<h2 id=\"getresource-by-id\">GetResource By ID<br></h2>\n<p>In order to query for a specific item use the following urls:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>api.letmehelp.life/cities/City Name\napi.letmehelp.life/charities/Charity_ID\napi.letmehelp.life/events/Event_ID\n</code></pre><p>Cities expects an exact city name match.\nBoth Events and Charities expect an exact ID.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5451526","collectionId":"cc50ec59-c1ba-4bbe-ae2d-cb445f957d9e","publishedId":"RWgm3gcV","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-10-02T22:18:59.000Z"},"item":[{"name":"Charities","item":[{"name":"getCharities","id":"eb80e058-3e4f-4356-b8a0-790a44673b10","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.letmehelp.life/charities?city=City&cause=Cause&state=State","description":"<p>Gets Charities with keywords.</p>\n","urlObject":{"protocol":"https","path":["charities"],"host":["api","letmehelp","life"],"query":[{"description":{"content":"<p>Exact city name</p>\n","type":"text/plain"},"key":"city","value":"City"},{"description":{"content":"<p>Partial cause text</p>\n","type":"text/plain"},"key":"cause","value":"Cause"},{"description":{"content":"<p>Exact state name</p>\n","type":"text/plain"},"key":"state","value":"State"},{"disabled":true,"key":"id","value":"Charity_ID"}],"variable":[]}},"response":[{"id":"f01d1c97-61ea-4bb4-9747-8cbdcd35640a","name":"Austin","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.letmehelp.life/charities/search?city=Austin","protocol":"https","host":["api","letmehelp","life"],"path":["charities","search"],"query":[{"key":"city","value":"Austin","description":"Requires 'state'"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[ \n\t{\n\t\t'cause': 'Food, Agriculture and Nutrition',\n\t\t'charityWebsite': 'www.austinfoodbank.org',\n\t\t'city': 'Austin',\n\t\t'descriptionHTML': '',\n\t\t'descriptionText': '',\n\t\t'donationUrl': 'http://donate.makemydonation.org/donate/742217350',\n\t\t'latitude': '30.175572',\n\t\t'logoUrl': 'https://img.evbuc.com/https%3A%2F%2Fcdn.evbuc.com%2Fimages%2F27421492%2F182321017494%2F2%2Foriginal.jpg?h=200&w=200&auto=compress&s=529ed1a39a60c9f55c12f117e58b33cf',\n\t\t'longitude': '-97.783306',\n\t\t'name': 'Central Texas Food Bank',\n\t\t'organizationId': '11076794572',\n\t\t'socialMedia': { 'facebook': 'CentralTexasFoodBank','twitter': 'ctxfoodbank'},\n\t\t'state': 'Texas',\n\t\t'zipCode': '78744-3123'\n\t},\n\t{ \n\t\t'cause': 'Not Provided',\n\t\t'charityWebsite': 'www.openlands.org',\n\t\t'city': 'Austin',\n\t\t'descriptionHTML': '<P><SPAN STYLE=\"font-family: ApexSans, Arial, '\n\t\t'sans-serif; font-size: 17px;\">\\xa0</SPAN></P>',\n\t\t'descriptionText': '\\xa0',\n\t\t'donationUrl': 'http://donate.makemydonation.org/donate/362649603',\n\t\t'latitude': '41.882900',\n\t\t'logoUrl': 'https://img.evbuc.com/https%3A%2F%2Fcdn.evbuc.com%2Fimages%2F43497538%2F245761583477%2F1%2Foriginal.png?h=200&w=200&auto=compress&s=e83f453ed517f07e1aaacd3d7420bed9',\n\t\t'longitude': '-87.626656',\n\t\t'name': 'NLand',\n\t\t'organizationId': '16876572806',\n\t\t'socialMedia': { 'facebook': 'nlandsurfpark', 'instagram': '2092989270', 'twitter': 'nlandsurfpark'},\n\t\t'state': 'Texas',\n\t\t'zipCode': '60602-1805'\n\t},\n\t{\n\t\t'cause': 'Animal-Related',\n\t\t'charityWebsite': '',\n\t\t'city': 'Austin',\n\t\t'descriptionHTML': '',\n\t\t'descriptionText': '',\n\t\t'donationUrl': 'http://donate.makemydonation.org/donate/742893360',\n\t\t'latitude': '30.269746',\n\t\t'logoUrl': 'https://img.evbuc.com/https%3A%2F%2Fcdn.evbuc.com%2Fimages%2F31943335%2F2712302136%2F2%2Foriginal.png?h=200&w=200&auto=compress&s=29073926b9a75bfdd0e2e3bd25a28b72',\n\t\t'longitude': '-97.759291',\n\t\t'name': 'American Pets Alive! at Austin Pets Alive!',\n\t\t'organizationId': '1381772169',\n\t\t'socialMedia': { 'facebook': 'americanpetsalive', 'twitter': 'AmPetsAlive'},\n\t\t'state': 'Texas',\n\t\t'zipCode': '78703-4603'\n\t}\n]\n"}],"_postman_id":"eb80e058-3e4f-4356-b8a0-790a44673b10"}],"id":"3a47ed71-2099-4a16-a1d3-6e7cc192c706","description":"<p>Get charities with filters.</p>\n","event":[{"listen":"prerequest","script":{"id":"22d57d29-95ad-4a1c-af73-2d3fefca4621","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1ab5eac2-7912-4c3b-9330-495aba46ceed","type":"text/javascript","exec":[""]}}],"_postman_id":"3a47ed71-2099-4a16-a1d3-6e7cc192c706"},{"name":"Cities","item":[{"name":"getCities","id":"64cc727d-dfc5-4cf4-bd0b-700520863229","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.letmehelp.life/cities?state=State&population=low-high&child_poverty_rate=low-high&income_below_poverty=low-high","description":"<p>Returns list of cities.</p>\n","urlObject":{"protocol":"https","path":["cities"],"host":["api","letmehelp","life"],"query":[{"description":{"content":"<p>Filter results by state.</p>\n","type":"text/plain"},"key":"state","value":"State"},{"description":{"content":"<p>integer range</p>\n","type":"text/plain"},"key":"population","value":"low-high"},{"description":{"content":"<p>float range</p>\n","type":"text/plain"},"key":"child_poverty_rate","value":"low-high"},{"key":"income_below_poverty","value":"low-high"}],"variable":[]}},"response":[{"id":"1fb0e389-3a25-4567-8cd6-1659360e24d7","name":"Test State","originalRequest":{"method":"GET","header":[{"key":"state","value":"TestState"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.letmehelp.life/cities?state=TestState","protocol":"https","host":["api","letmehelp","life"],"path":["cities"],"query":[{"key":"state","value":"TestState","description":"Filter results by state."}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"data_year\": \"2016\",\n        \"children_in_poverty\": \"0.0\",\n        \"city_name\": \"TestCity\",\n        \"income_below_poverty\": \"0.0\",\n        \"population\": \"1\",\n        \"description\": \"Testing\",\n        \"state\": \"TestState\"\n    }\n]"}],"_postman_id":"64cc727d-dfc5-4cf4-bd0b-700520863229"}],"id":"ac92179f-2c5a-4085-9b0c-4e5f6d74ad9f","description":"<p>Gets locations currently in database.\nCan filter by state, statistics.</p>\n","event":[{"listen":"prerequest","script":{"id":"3ad9cf83-6515-4f74-aa81-357740908c02","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ab08e5fb-2ccc-4b73-9bcb-ed96fdc4c663","type":"text/javascript","exec":[""]}}],"_postman_id":"ac92179f-2c5a-4085-9b0c-4e5f6d74ad9f"},{"name":"Events","item":[{"name":"getEvents","id":"3e3242cf-c08d-4354-ac0d-db52441d8911","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.letmehelp.life/events?city=City&state=State&charity_id=Charity_Id&date=yyyy-MM-ddThh:mm:ssZ","urlObject":{"protocol":"https","path":["events"],"host":["api","letmehelp","life"],"query":[{"description":{"content":"<p>Filter results by city</p>\n","type":"text/plain"},"key":"city","value":"City"},{"description":{"content":"<p>Filter results by state</p>\n","type":"text/plain"},"key":"state","value":"State"},{"description":{"content":"<p>Filter results by charity</p>\n","type":"text/plain"},"key":"charity_id","value":"Charity_Id"},{"description":{"content":"<p>Get all events on yyyy-MM-ddThh:mm:ssZ</p>\n<p>This needs a timezone. For example, to get all events\non January 1st, 2018 EST (-5 UTC) do:<br />\n\"date=2018-01-01T05:00:00Z\"</p>\n","type":"text/plain"},"key":"date","value":"yyyy-MM-ddThh:mm:ssZ"}],"variable":[]}},"response":[{"id":"388611e7-52e7-4cd0-ae83-e9d79b1e7085","name":"Austin Poverty Events","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://api.letmehelp.life/events?city=TestCity","protocol":"https","host":["api","letmehelp","life"],"path":["events"],"query":[{"key":"city","value":"TestCity"},{"key":"charity_id","value":"\"Charity ID\"","disabled":true},{"key":"months","value":"\"3\"","description":"month range to include results in","disabled":true},{"key":"days","value":"\"23\"","description":"days range to include results in","disabled":true},{"key":"lat_long","value":"lat,long","description":"comma separated list of latitude,longitude","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"eventId\": \"9999999999999\",\n        \"logoUrl\": \"Test\",\n        \"descriptionHTML\": \"Test\",\n        \"address_city\": \"TestCity\",\n        \"address_1\": \"100 Test Dr.\",\n        \"name\": \"Test\",\n        \"eventUrl\": \"TestUrl\",\n        \"address_2\": \"Test2\",\n        \"state\": \"TestState\",\n        \"city\": \"TestCity\",\n        \"startTime\": \"2018-11-13T13:15:00\",\n        \"zipcode\": \"78744\",\n        \"localized_address_display\": \" 6500 Metropolis Dr, Austin, Texas 78744\",\n        \"endTime\": \"2018-11-13T18:00:00\",\n        \"organizationId\": \"88888888888888\",\n        \"venueId\": \"27233070\",\n        \"longitude\": \"-97.71027319999996\",\n        \"descriptionText\": \"Test\",\n        \"latitude\": \"30.2034364\"\n    }\n]"}],"_postman_id":"3e3242cf-c08d-4354-ac0d-db52441d8911"}],"id":"311bf7a6-89c3-4c8a-b074-4b7d7880059d","description":"<p>Gets events by keyword/parameters.</p>\n","event":[{"listen":"prerequest","script":{"id":"c1931bca-fea3-46b2-89d9-baeee3490480","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"39829fff-9723-40a8-8896-3c7ecf6633ee","type":"text/javascript","exec":[""]}}],"_postman_id":"311bf7a6-89c3-4c8a-b074-4b7d7880059d"}],"event":[{"listen":"prerequest","script":{"id":"c7f08f68-9647-451c-ae50-31e4b07b5a04","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"87841d93-b101-4472-aabf-b9f4340c28cd","type":"text/javascript","exec":[""]}}]}