Difference between revisions of "API Dictionaries"
(Created page with "right Many of the values returned by the API are IDs, so there's a selection of dictionaries to get the friendly names. As a (slow and heavy) re...") |
|||
| Line 19: | Line 19: | ||
[GET] https://api.dizions.co.uk/v2/dictionary/search/referrals/referrer/SEARCH_TERM | [GET] https://api.dizions.co.uk/v2/dictionary/search/referrals/referrer/SEARCH_TERM | ||
| + | |||
| + | For Extension Database which are "Select From Option List" or "Radio buttons", there is a dictionary for each field: | ||
| + | https://api.dizions.co.uk/v2/dictionary/extension_database/INSERT_API_COLLABORATION_NAME_HERE | ||
---- | ---- | ||
Revision as of 14:39, 23 March 2020
Many of the values returned by the API are IDs, so there's a selection of dictionaries to get the friendly names. As a (slow and heavy) reference you can get all datadict dictionaries:
[GET] https://api.dizions.co.uk/v2/dictionary (not suggested for general use)
If the dictionary is set up in datadict you can access via api_group/table_reference. The end points below will return the full list of IDs and friendly names.
[GET] https://api.dizions.co.uk/v2/dictionary/organisations/district
[GET] https://api.dizions.co.uk/v2/dictionary/referrals/project
[GET] https://api.dizions.co.uk/v2/dictionary/contacts/contact_type
You can also search for items in the dictionary:
[GET] https://api.dizions.co.uk/v2/dictionary/search/referrals/project/SEARCH_TERM
[GET] https://api.dizions.co.uk/v2/dictionary/search/referrals/referrer/SEARCH_TERM
For Extension Database which are "Select From Option List" or "Radio buttons", there is a dictionary for each field: https://api.dizions.co.uk/v2/dictionary/extension_database/INSERT_API_COLLABORATION_NAME_HERE
