Difference between revisions of "API Details"
(→Purchasing and getting started) |
|||
| Line 1: | Line 1: | ||
[[File:helpheader_small.png|right]] | [[File:helpheader_small.png|right]] | ||
| − | 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. | + | 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. To enable API user please see [Users#3rd_Party_System_Access] |
Revision as of 10:27, 8 June 2023
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. To enable API user please see [Users#3rd_Party_System_Access]
Contents
General Concepts
API Entities
The API is based around various entities:
classification_codes, a tiered coding system used to classify done_contacts using .
clients, who 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.
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.
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, 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
