Difference between revisions of "API Classification Codes"
From Charitylog Manual
| (One intermediate revision by one other user not shown) | |||
| Line 12: | Line 12: | ||
Codes are return as a JSON object, and can be fetched like any other field. There are 3 options: | 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 | + | 1) Codes linked to done_contacts: |
[GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/field/codes | [GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/field/codes | ||
| − | 2) Codes linked to directly to referrals | + | 2) Codes linked to directly to referrals: |
[GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/field/referral_codes | [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 | + | 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 | [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. | ||
Latest revision as of 16:32, 29 November 2024
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.
