Difference between revisions of "API Details"
From Charitylog Manual
(→API Entities) |
(→API Entities) |
||
| Line 20: | Line 20: | ||
|- | |- | ||
| [[API_clients|clients]] || Organisations/people that are people, e.g. clients, staff volunteers etc. || Y || Clients, Service Users, Staff, Volunteers | | [[API_clients|clients]] || Organisations/people that are people, e.g. clients, staff volunteers etc. || Y || Clients, Service Users, Staff, Volunteers | ||
| − | |||
| − | |||
|- | |- | ||
| [[API_done_contacts|done_contacts]] || Completed actions || N || Contacts | | [[API_done_contacts|done_contacts]] || Completed actions || N || Contacts | ||
| Line 30: | Line 28: | ||
|- | |- | ||
| [[API_external_referrals|external_referrals]] || Referrals collected externally, e.g. a self-referral form on your website || N || Inbound Referrals | | [[API_external_referrals|external_referrals]] || Referrals collected externally, e.g. a self-referral form on your website || N || Inbound Referrals | ||
| + | |- | ||
| + | | [[Project_Set_Up|project]] || A service your organisation provides || Y || Project, Service, Department | ||
| + | |- | ||
| + | | [[API_referrals|referrals]] || Groups of done_contacts and due_contacts || Y || Referrals, Cases, Enquiries | ||
|- | |- | ||
| [[API_relationships| relationship_details]] || Relationships between 2 people, e.g. parent, social worker, carer etc || N || Relationships | | [[API_relationships| relationship_details]] || Relationships between 2 people, e.g. parent, social worker, carer etc || N || Relationships | ||
| Line 35: | Line 37: | ||
| [[API_schedules|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 | | [[API_schedules|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 | ||
|- | |- | ||
| − | | [[ | + | | [[Referral_Templates#The_Stages.2FStatuses|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 |
|- | |- | ||
| [[Referral_Templates|template]] || A workflow, e.g. a collection of stages to guide you through a case || N || Template | | [[Referral_Templates|template]] || A workflow, e.g. a collection of stages to guide you through a case || N || Template | ||
|- | |- | ||
| − | | [[ | + | | [[API_workers|workers]] || People who work on schedules || Y || Home Helpers, Support Workers, Carers |
| − | |||
| − | |||
|} | |} | ||
Revision as of 12:33, 18 October 2023
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 |
| 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 |
| project | A service your organisation provides | Y | Project, Service, Department |
| referrals | Groups of done_contacts and due_contacts | Y | Referrals, Cases, Enquiries |
| 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 |
| 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 |
| template | A workflow, e.g. a collection of stages to guide you through a case | N | Template |
| workers | People who work on schedules | Y | Home Helpers, Support Workers, Carers |
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
