Difference between revisions of "API Details"
(→API Entities) |
(→API Entities) |
||
| Line 17: | Line 17: | ||
[[API_clients|clients]], which are organisations/people that are people, e.g. clients, staff volunteers etc. | [[API_clients|clients]], which are organisations/people that are people, e.g. clients, staff volunteers etc. | ||
| − | [[API_done_contacts| | + | [[API_done_contacts|done_contacts]], which are completed actions. |
| − | [[API_due_contacts|due_contacts]] | + | [[API_due_contacts|due_contacts]], which are outstanding actions that typically make up the Action List in the web application. |
| − | [[API_external_referrals|external_referrals]] | + | [[API_external_referrals|external_referrals]], which are referrals collected externally, e.g. a self-referral form on your website. |
| − | [[API_referrals|referrals]] | + | [[API_referrals|referrals]], which are are a groups of done_contacts and due_contacts. |
| − | [[API_relationships| relationship_details]] | + | [[API_relationships| relationship_details]] between 2 people, e.g. parent, social worker, carer etc. |
| − | [[API_schedules|schedules]] | + | [[API_schedules|schedules]], which are Roster job cards. |
| − | [[API_workers|workers]] | + | [[API_workers|workers]], which are the people who work on schedules. |
=Reading data (GETs)= | =Reading data (GETs)= | ||
Revision as of 14:45, 11 September 2020
On this page you will find some technical details of the Dizions API that works with the system. This enables you to interact with your data without having to log in to the web interface. It is a RESTful API using JSON over https. For prices, please call the office.
Contents
General Concepts
API Entities
clients, which are organisations/people that are people, e.g. clients, staff volunteers etc.
done_contacts, which are completed actions.
due_contacts, which are outstanding actions that typically make up the Action List in the web application.
external_referrals, which are referrals collected externally, e.g. a self-referral form on your website.
referrals, which are are a groups of done_contacts and due_contacts.
relationship_details between 2 people, e.g. parent, social worker, carer etc.
schedules, which are Roster job cards.
workers, which are the people who work on schedules.
