Difference between revisions of "API Classification Codes"
From Charitylog Manual
| Line 1: | Line 1: | ||
[[API Details|Go to API overview]] | [[API Details|Go to API overview]] | ||
| − | Classification codes are used to classify done_contacts using a tiered coding system. See [[Classification_Codes|this page]] for more information. | + | Classification codes are used to classify referrals and done_contacts using a tiered coding system. See [[Classification_Codes|this page]] for more information. |
Codes are divided into groups. These can be found using the dictionary: | Codes are divided into groups. These can be found using the dictionary: | ||
| Line 10: | Line 10: | ||
[GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/classification_codes_tree/123 | [GET] https<nowiki/>://api.dizions.co.uk/v2/dictionary/classification_codes_tree/123 | ||
| − | Codes are return as a JSON object | + | Codes are return as a JSON object, and can be fetched like any other field. There are 3 options: |
| − | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/field/ | + | |
| + | 1) Codes linked to done_contacts | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/field/codes | ||
| + | |||
| + | 2) Codes linked to directly to referrals | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/field/referral_codes | ||
| + | |||
| + | 3) Codes linked to referrals, either directly, or to one of the referral's done_contacts | ||
| + | [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/field/codes | ||
| + | |||
It is not currently possible to put or post classification codes. | It is not currently possible to put or post classification codes. | ||
Revision as of 13:14, 2 August 2023
Classification codes are used to classify referrals and done_contacts using a tiered coding system. See this page for more information.
Codes are divided into groups. These can be found using the dictionary:
[GET] https://api.dizions.co.uk/v2/dictionary/classification_codes_groups
Each code group uses a tree structure, which can be looked up by id:
[GET] https://api.dizions.co.uk/v2/dictionary/classification_codes_tree/123
Codes are return as a JSON object, and can be fetched like any other field. There are 3 options:
1) Codes linked to done_contacts
[GET] https://api.dizions.co.uk/v2/done_contacts/field/codes
2) Codes linked to directly to referrals
[GET] https://api.dizions.co.uk/v2/referrals/field/referral_codes
3) Codes linked to referrals, either directly, or to one of the referral's done_contacts
[GET] https://api.dizions.co.uk/v2/referrals/field/codes
It is not currently possible to put or post classification codes.
