Difference between revisions of "API Classification Codes"

From Charitylog Manual
Jump to: navigation, search
Line 11: Line 11:
  
 
Codes are return as a JSON object attached to each done_contacts, and can be fetched like any other field:
 
Codes are return as a JSON object attached to each done_contacts, and can be fetched like any other field:
  [GET] https<nowiki/>://api.dizions.co.uk/v2/done_contacts/field/id;client_postcode;codes
+
  [GET] https<nowiki/>://api.dizions.co.uk/v2/referrals/field/id;client_postcode;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:57, 19 July 2023

Go to API overview

Classification codes are used to classify 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 attached to each done_contacts, and can be fetched like any other field:

[GET] https://api.dizions.co.uk/v2/referrals/field/id;client_postcode;codes

It is not currently possible to put or post classification codes.