Difference between revisions of "API Entities"
From Charitylog Manual
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
The API is based around various entities: | The API is based around various entities: | ||
| − | * clients. These are organisations/people that are people, e.g. clients, staff volunteers etc. | + | * '''clients.''' These are organisations/people that are people, e.g. clients, staff volunteers etc. |
| − | * referrals. These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. Only referral using a template are available in the API. In a future release of the web application, templates will be automatically created when new projects are created, so that all referrals will be available in the API. If you have older referrals without a template that you wish to access via the API, please contact the support team. | + | * '''referrals'''. These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. Only referral using a template are available in the API. In a future release of the web application, templates will be automatically created when new projects are created, so that all referrals will be available in the API. If you have older referrals without a template that you wish to access via the API, please contact the support team. |
| − | * done_contacts. These are completed actions. | + | * '''done_contacts.''' These are completed actions. |
| − | * due_contacts. These are outstanding actions that typically make up the Action List in the web application. | + | * '''due_contacts.''' These are outstanding actions that typically make up the Action List in the web application. |
| − | * workers. These are the people who work on Roster Job Cards. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. | + | * '''workers.''' These are the people who work on Roster Job Cards. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. |
| − | * schedules. These are Roster job cards. | + | * '''schedules.''' These are Roster job cards. |
| − | * external_referrals. These are referrals collected externally, e.g. a self-referral form on your website. | + | * '''external_referrals.''' These are referrals collected externally, e.g. a self-referral form on your website. |
An example URL would look like: | An example URL would look like: | ||
| − | [GET] https<nowiki/>://api.dizions.co.uk/v2/clients | + | [GET] https<nowiki/>://api.dizions.co.uk/v2/clients/37 |
Latest revision as of 13:56, 1 May 2024
The API is based around various entities:
- clients. These are organisations/people that are people, e.g. clients, staff volunteers etc.
- referrals. These are a groups of cohesive actions. These are typically called 'cases' in the web application. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API. Only referral using a template are available in the API. In a future release of the web application, templates will be automatically created when new projects are created, so that all referrals will be available in the API. If you have older referrals without a template that you wish to access via the API, please contact the support team.
- done_contacts. These are completed actions.
- due_contacts. These are outstanding actions that typically make up the Action List in the web application.
- workers. These are the people who work on Roster Job Cards. The web application's terminology section allows these to be renamed, but they are always called 'referrals' in the API.
- schedules. These are Roster job cards.
- external_referrals. These are referrals collected externally, e.g. a self-referral form on your website.
An example URL would look like:
[GET] https://api.dizions.co.uk/v2/clients/37
