|
|
| Line 27: |
Line 27: |
| | [[Reporting Via The API]] | | [[Reporting Via The API]] |
| | | | |
| − | =Dictionaries=
| + | [[API Dictionaries]] |
| − | 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
| |
Revision as of 09:58, 5 August 2019
On this page you will find some technical details of the Dizions API that works with the system. This enables you to interact with your data without having to log in to the web interface. It is a RESTful API using JSON over https. For prices, please call the office.
File:API.png
API Authentication
API Groups
API Filters
Selecting Specific Fields Via The API
Creating Records Via The API
Updating Records Via The API
External Referrals To The API
File Uploads Using The API
Extension Databases Via The API
Reporting Via The API
API Dictionaries
