API Details
On this page you will find some technical details of the Dizions API that works with the system. This enables technical users capable of writing their own applications 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. To enable API users please see Users.
Contents
General Concepts
API Entities
| API name | Description | Renamable in web app? | Typical names in web app |
|---|---|---|---|
| classification_codes | A tiered coding system used to classify done_contacts | Y | Classification code, enquiry codes |
| clients | Organisations/people that are people, e.g. clients, staff volunteers etc. | Y | Clients, Service Users, Staff, Volunteers |
| referrals | roups of done_contacts and due_contacts | Y | Referrals, Cases, Enquiries |
done_contacts, which are completed actions.
due_contacts, which are outstanding actions that typically make up the Action List in the web application.
extension_databases, used to create your own data structures for forms etc
external_referrals, which are referrals collected externally, e.g. a self-referral form on your website.
relationship_details between 2 people, e.g. parent, social worker, carer etc.
schedules, which are Roster job cards.
workers, who are the people who work on schedules.
Other
Reading data (GETs)
Writing data (POSTs and PUTs)
Making the most of your data
Getting Started with Power Query with Excel
Getting Started with Power Query in Power BI Desktop
How to achieve more with Power Query
