Difference between revisions of "API clinics"
From Charitylog Manual
(→Attendances) |
|||
Line 9: | Line 9: | ||
[GET] https<nowiki/>://api.dizions.co.uk/v2/attendances/project/1/start/2024-12-01,2024-12-31/attended/Y | [GET] https<nowiki/>://api.dizions.co.uk/v2/attendances/project/1/start/2024-12-01,2024-12-31/attended/Y | ||
− | Note the attended/Y filter. Non-attendances can be used using attended/N. | + | Note the attended/Y filter. Non-attendances can be used using /attended/N. |
You may also want to filter by the clinic, e.g. this will add a filter to only show attendances at clinics 3 and 7. | You may also want to filter by the clinic, e.g. this will add a filter to only show attendances at clinics 3 and 7. |
Revision as of 10:00, 25 November 2024
Contents
Attendances
Attendances are the planned and actual attendances at meetings. They can be retrieved, typically by filtering on project and date using:
[GET] https://api.dizions.co.uk/v2/attendances/project/1/start/2024-12-01,2024-12-31/attended/Y
Note the attended/Y filter. Non-attendances can be used using /attended/N.
You may also want to filter by the clinic, e.g. this will add a filter to only show attendances at clinics 3 and 7.
[GET] https://api.dizions.co.uk/v2/attendances/project/1/start/2024-12-01,2024-12-31/attended/Y/clinic/3;7
Clinics
Clinics are the names of the groups, after-school clubs, day centres etc that your organisation runs. They can be retrieved using:
[GET] https://api.dizions.co.uk/v2/clinics
You can also filter, typically by project:
[GET] https://api.dizions.co.uk/v2/clinics/project_id/5
To select specific fields, add them after /fields:
[GET] https://api.dizions.co.uk/v2/clinics/field/id;name;maximum_number_of_members
To see a list of selectable fields, use:
[GET] https://api.dizions.co.uk/v2/clinics/selectable_fields
Typically you would use this list as a lookup list for attendances