Difference between revisions of "API Entities"
From Charitylog Manual
| Line 6: | Line 6: | ||
* clients (organisations that are "people") | * clients (organisations that are "people") | ||
| − | * referrals ( | + | * referrals (These are a groups of cohesive actions. These are typically called Cases in web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API) |
* done_contacts (completed actions) | * done_contacts (completed actions) | ||
* due_contacts (outstanding actions) | * due_contacts (outstanding actions) | ||
Revision as of 13:56, 11 August 2020
The API is based around various entities:
- clients (organisations that are "people")
- referrals (These are a groups of cohesive actions. These are typically called Cases in web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API)
- done_contacts (completed actions)
- due_contacts (outstanding actions)
- workers (support workers)
- schedules (job cards)
- external_referrals (referrals collected externally, e.g. a self-referral form on your website )
An example URL would look like (GET) https://api.dizions.co.uk/v2/clients
