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.

General Concepts

Why_use_an_API

API Dictionaries

API Authentication

API Entities

The API is based around various 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	Groups of done_contacts and due_contacts	Y	Referrals, Cases, Enquiries
done_contacts	Completed actions	N	Contacts
due_contacts	Outstanding actions that typically make up the Action List in the web application	N	Outstanding actions
extension_databases	Used to create your own data structures for forms etc	N	Extension Databases
external_referrals	Referrals collected externally, e.g. a self-referral form on your website	N	Inbound Referrals
relationship_details	Relationships between 2 people, e.g. parent, social worker, carer etc	N	Relationships
schedules	Roster job cards	N	Jobs cards is not renamable, but the workers are, e.g. Home Helper Job Cards, Support Worker Job Cards etc
workers	People who work on schedules	Y	Home Helpers, Support Workers, Carers
project	A service your organisation provides	Y	Project, Service, Department
template	A workflow, e.g. a collection of stages to guide you through a case	N	Template
stage	A stage on a template, e.g. Initial Assessment	N	Stage
Status	A broad grouping of a stage, e.g. Being Supported, Not For Reports etc	N	Status