{"info":{"_postman_id":"e818e0f2-2770-4354-82ab-c3b7ef489164","name":"Generations API","description":"

This API allows for generic interaction with the Generations Homecare System | A solution from Integrated Database Systems

This API implements rate limiting at the current moment you will be rate limited to 10 queries per second and 100 per minute.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5594575","collectionId":"e818e0f2-2770-4354-82ab-c3b7ef489164","publishedId":"T17Q6QEF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-15T16:23:07.000Z"},"item":[{"name":"Account (Get Token)","item":[{"name":"Get Token","event":[{"listen":"test","script":{"id":"84ce07a5-1397-4a8d-95db-8cfa973b73d4","exec":["const responseJson = pm.response.json();\r","postman.setEnvironmentVariable(\"token\", responseJson.access_token);\r","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200); });"],"type":"text/javascript"}}],"id":"ae77bc63-1b0c-420e-8b34-32eb57645566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"FakeValue","description":"

This will need to be updated with real values

\n","type":"text"},{"key":"password","value":"FakeValue","description":"

This will need to be updated with real values

\n","type":"text"}]},"url":"https://api.idb-sys.com/token","description":"

This will get a barrer token that you will need to pass into your data requests. This token is valid for a 24 hour period. You will need to request a new token when your current token expires. The response json for this call will contain a field called expires_in that shows how long the token will be valid in seconds.

\n","urlObject":{"protocol":"https","path":["token"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae77bc63-1b0c-420e-8b34-32eb57645566"}],"id":"a51da45e-d079-4e18-8444-7103797a40b6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a154ccb3-05d4-4afe-896d-994cd8f3b881","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ff4b1e7e-fbfe-4c5a-a56a-89017f8095fd","type":"text/javascript","exec":[""]}}],"_postman_id":"a51da45e-d079-4e18-8444-7103797a40b6","description":""},{"name":"Data Requests","item":[{"name":"Caregiver","item":[{"name":"Caregiver Hours","item":[{"name":"Get Caregiver Hours","id":"40294329-7a28-4f65-968d-7a07cb01e162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"","value":"","type":"text"},{"key":"","value":"","type":"text"},{"key":"","value":"","type":"text"},{"key":"","value":"","type":"text","equals":false}],"url":"https://api.idb-sys.com/api/CaregiverHours?startDateTime=2021-03-01T14:23:00.000Z&endDateTime=2021-03-08T14:23:00.000Z&optionalClassFilter&optionalCaregiverPayrollId","description":"

This allows for querying of confirmed and unconfirmed hours for up to a seven day period. Their are optional class and caregiver id filters. To get a list of valid classes please use the Class/Get Class API endpoint

This call will return inservice events for a specific user. Employee Guid must be passed as a url paramater for this call. Employee Guid can be found using Get Cargiver with Guid call (api/CaregiversWithGuid)

Employee Guid can be found using Get Cargiver with Guid call

\n","type":"text/plain"},"key":"EmployeeGuid","value":"EmployeeGuidGoesHere"}],"variable":[]}},"response":[],"_postman_id":"73d6e274-540b-457d-b614-f326f22185d0"},{"name":"Post New Inservice","id":"52566688-235c-4a52-a0c4-6a55f4b8782b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"EmployeeGuid\": \"51AFBB69-5F09-4B3A-8369-0A1C02B14B36\",\r\n \"DateTimeInServiceOccurred\": \"2023-04-24T00:00:00\",\r\n \"InServiceEventName\": \"NewInserviceName\",\r\n \"Units\": \"3.5\",\r\n \"Notes\": \"This note is not visible in the UI\"\r\n }","options":{"raw":{"language":"json"}}},"description":"

This call allows for adding a new inservice event to the caregiver profile under the inservice tab. If a inservice name (InServiceEventName) is passed that does not exist (case sensitive) a new active inservice master list item will be created. The employee guid is available from CaregiversWithGuid api call (see caregiver section for details.) The was added to allow for better identifcation of caregivers when feterating data from external systems.

This allows for getting a list of caregivers

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}},"urlObject":{"protocol":"https","path":["api","Caregivers"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5f46f39-9826-45e3-862d-3b74af3586c6"},{"name":"Get Caregiver with guid","id":"a22b0021-d5c4-455d-80f1-66fb22ceee73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.idb-sys.com/api/CaregiversWithGuid","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}},"urlObject":{"protocol":"https","path":["api","CaregiversWithGuid"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a22b0021-d5c4-455d-80f1-66fb22ceee73"},{"name":"Post New Caregiver","id":"8d108a56-8fc7-4595-9906-c25ce197335f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\r\n \"employeeId\": \"1234\",\r\n \"firstName\": \"firstName\",\r\n \"middleInitial\": null,\r\n \"lastName\": \"lastName\",\r\n \"phoneNumber1\": \"9895551212\",\r\n \"phoneNumber2\": \"\",\r\n \"email\": \"test@idb-sys.com\",\r\n \"applicationDate\": null,\r\n \"hireDate\": null,\r\n \"dateOfBirth\": \"2020-10-15T00:00:00\",\r\n \"stateLicense\": null,\r\n \"payrollId\": null,\r\n \"address1\": \"\",\r\n \"address2\": \"\",\r\n \"city\": \"\",\r\n \"state\": \" \",\r\n \"postalCode\": \"\"\r\n }","options":{"raw":{"language":"json"}}},"url":"https://api.idb-sys.com/api/Caregivers","description":"

This allows for insert of a new caregiver.

This request returns all caregiver custom field values. The \"caregiverUniqueId\" can be associated with a specific caregiver by calling the \"CaregiversWithGuid\" and matching the returned \"guid\" value with the \"caregiverUniqueId\" value from this request.

\n","urlObject":{"protocol":"https","path":["api","CaregiversCustomField"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a7bc8ca9-658b-4728-a8a1-63d73c6e2286"}],"id":"847fbf5b-93e0-4a03-b7ce-d49f57d904db","_postman_id":"847fbf5b-93e0-4a03-b7ce-d49f57d904db","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}}},{"name":"Class","item":[{"name":"Get Class","id":"85044fa0-dfe0-4a58-a959-a044d06353e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.idb-sys.com/api/Class","description":"

This gets a list of classes

This retrieves all call center notes that are related to Referral Sources

This retrieves all call center notes that have a specific parent referral source Id

This will get all call center notes that are created/updated after a specific date and time

This will allow for getting call center notes related to parent record referral data

\n","event":[{"listen":"prerequest","script":{"id":"b0e25ca1-62ce-470f-ada7-248419cc095b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4bb24681-7188-4d68-b035-30889d1abc59","type":"text/javascript","exec":[""]}}],"_postman_id":"2f189c1f-8975-47a2-9abe-b2b89771c0ac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}}},{"name":"GetAll","id":"5890788e-a3d8-4493-a2a5-92258ce1c9a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.idb-sys.com/api/ReferralSources","description":"

This will allow you to get Referral Source data

This will allow you to get Referral Source data with a specific Id

This will allow you to get Referral Source data filtered by either active or inactive status

This will allow you to get referral source data filtering by if the full name contains the passed in parameter value

This will search for all referral source data where company name contains the parameter text

This will get all referral source data that are created/updated after a specific date and time

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ReferralSources","GetByAddedOrUpdatedAfterDate"],"host":["api","idb-sys","com"],"query":[{"key":"date","value":"2019-07-01T14%3A23%3A00.000"}],"variable":[]}},"response":[],"_postman_id":"460dffdd-91bb-4ef3-9353-949a41d644d2"},{"name":"StoreData","id":"bc7c244c-3ecd-4498-8e7a-49708a525594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"First Last\",\r\n \"Company\": \"Test Company\",\r\n \"Salutation\": \"Salutation\",\r\n \"Title\": \"Title\",\r\n \"Department\": \"Department\",\r\n \"PhoneNumber\": \"PhoneNumber\",\r\n \"PhoneMobile\": \"MobileNumber\",\r\n \"Fax\": \"FaxNumber\",\r\n \"ActiveStatus\": \"Active\",\r\n \"Notes\": \"Notes\",\r\n \"Address\": \"Address\",\r\n \"City\": \"City\",\r\n \"State\": \"State\",\r\n \"ZipCode\": \"ZipCode\",\r\n \"Website\": \"Website\",\r\n \"Email\": \"Email\",\r\n \"StatusDetail\": \"StatusId\",\r\n \"Type\": \"TypeId\",\r\n \"Location\": \"Loc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.idb-sys.com/api/ReferralSources/","description":"

Note: this uses the same call as UpdateData, to store new data do not pass in a \"Id\" value

If a new type that does not exist in the database is passed in it will be added to the master list. \nIf a location does not exist you will receive an error from the API

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}},"urlObject":{"protocol":"https","path":["api","ReferralSources",""],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc7c244c-3ecd-4498-8e7a-49708a525594"},{"name":"UpdateData","id":"588d9d3e-526d-42f7-bf0a-7e465a9f295c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Id\": \"agencyid-4\",\r\n \"Name\": \"First2 Last1\",\r\n \"Company\": \"Test Company\",\r\n \"Salutation\": \"Salutation\",\r\n \"Title\": \"Title\",\r\n \"Department\": \"Department\",\r\n \"PhoneNumber\": \"PhoneNumber\",\r\n \"PhoneMobile\": \"MobileNumber\",\r\n \"Fax\": \"FaxNumber\",\r\n \"ActiveStatus\": \"Active\",\r\n \"Notes\": \"Notes\",\r\n \"Address\": \"Address\",\r\n \"City\": \"City\",\r\n \"State\": \"State\",\r\n \"ZipCode\": \"ZipCode\",\r\n \"Website\": \"Website\",\r\n \"Email\": \"Email\",\r\n \"StatusDetail\": \"StatusId\",\r\n \"Type\": \"TypeId\",\r\n \"Location\": \"Loc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.idb-sys.com/api/ReferralSources/","description":"

Note: this uses the same call as StoreData, to update pass in the current \"Id\" value

If a new type that does not exist in the database is passed in it will be added to the master list. \nIf a location does not exist you will receive an error from the API

This collection of API calls will allow for getting referral data and also call center notes related to referral data

\n","event":[{"listen":"prerequest","script":{"id":"9e995631-227d-4407-8985-30061d055b22","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb97c780-a440-4dfc-ad8b-e2e06dba1663","type":"text/javascript","exec":[""]}}],"_postman_id":"ba983c05-8892-4277-b2b0-e7f797bd28d3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}}},{"name":"Client","item":[{"name":"Get Client","id":"def7667b-0b2c-49f8-b937-92ff6edb6f3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.idb-sys.com/api/clients","urlObject":{"protocol":"https","path":["api","clients"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"def7667b-0b2c-49f8-b937-92ff6edb6f3d"},{"name":"Get Client Custom Fields","id":"1ea9a966-7429-4222-98ff-f5aa78c6d8c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.idb-sys.com/api/clientsCustomFields","urlObject":{"protocol":"https","path":["api","clientsCustomFields"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ea9a966-7429-4222-98ff-f5aa78c6d8c0"},{"name":"Get Client Service Request","id":"6e43893b-66d8-4f42-9304-7b57714936a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.idb-sys.com/api/ServiceRequest","urlObject":{"protocol":"https","path":["api","ServiceRequest"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6e43893b-66d8-4f42-9304-7b57714936a8"},{"name":"Get Client notes","id":"52ea58cd-460b-48de-9353-5f2f43974f78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.idb-sys.com/api/ClientNotes?startDateTime=2025-01-01T14:23:00.000&endDateTime=2025-03-08T14:23:00.000","urlObject":{"protocol":"https","path":["api","ClientNotes"],"host":["api","idb-sys","com"],"query":[{"key":"startDateTime","value":"2025-01-01T14:23:00.000"},{"key":"endDateTime","value":"2025-03-08T14:23:00.000"}],"variable":[]}},"response":[],"_postman_id":"52ea58cd-460b-48de-9353-5f2f43974f78"},{"name":"Client Contact","id":"4479bad0-66b4-463f-a6e4-dba69885ff2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.idb-sys.com/api/ClientContact","urlObject":{"protocol":"https","path":["api","ClientContact"],"host":["api","idb-sys","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"4479bad0-66b4-463f-a6e4-dba69885ff2f"}],"id":"c4b7930a-e7a9-4fad-bcce-408e74e16ed8","_postman_id":"c4b7930a-e7a9-4fad-bcce-408e74e16ed8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","name":"Data Requests","type":"folder"}}}],"id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252","description":"

This will allow you to request data from generations. You will need to use the Account/GetToken call to get a bearer token before you are able to use these API calls for data.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"6e442fdd-0b01-4929-867f-99baa698a9b3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7cbbe240-cd0f-4788-8cbe-b6798822fdd8","type":"text/javascript","exec":[""]}}],"_postman_id":"9ec4f1ba-a6e5-4ec8-b50d-0acea7363252"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"b35b4dba-708d-493b-b2f7-6a3f333d6f44","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2e73cd6b-2277-4b71-ac55-3a5b494fe631","type":"text/javascript","exec":[""]}}]}