API Reference Documentation
Seren data can be accessed securely via SOAP or GET requests over HTTPS. A variety of data formats can be returned, including JSON, XML and CSV, using the various endpoint options that are available.
Base URL
Each API has a base URL on which the required data endpoint can be appended, such as:
https://api.caseworkerconnectonline.org/Seren/FindPerson/v1.1/
https://api.caseworkerconnectonline.org/Seren/GetPersonByID/v1.1/Authentication
APIs require authentication in the form of a key, which can be requested through your product manager. Each key has its own security settings (URL & IP restriction, usage limits), and as many keys as necessary can be set up with these restrictions.
A key must be passed to the API as a parameter in order for the request to authenticate, otherwise an error will be returned.
API
The API is split into two main subject areas: Person and Casework. APIs for the Person allow search and retrieval of specific person data points. The Casework APIs return case data for a specific person id.
The API is being extended to support additional data points and if you have a specific API request please email topher@bluedoorsoftware.co.uk to raise a new endpoint request for consideration for implementation.