API Details

From Charitylog Manual
Jump to: navigation, search
Helpheader small.png

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.


API.png

General Concepts

Why_use_an_API

API Dictionaries

API Authentication

API Entities

The API is based around various entities:

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

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

File Uploads

Reading data (GETs)

API Filters

Selecting Specific Fields

Running Reports

Writing data (POSTs and PUTs)

Creating Records

Updating Records

External Referrals

Making the most of your data

Getting Started with Power Query with Excel

Getting Started with Power Query in Power BI Desktop

Purchasing and getting started

Purchasing