Introduction

From time to time there will a need to update these documents. When this is done it will be logged in this document.

2023-03-29

Changes:

• Fixed managed UI issue of being able to set a blank answer and then save the condition.

2022-12-14

This release brings in a new API version: v1.2.0. Since this is not a breaking change, you will not need to do anything as this is automatically the default version of the API.

Added:

• Altitude Exclusions [API]
  • This new feature has been added in a backwards compatible manner, if you wish to utilise it you can modify your post request when creating a new screening session and add in the new altitudeExclusions key as true to the settings object. Example:

{
    "settings": {
        "altitudeExclusions": true
    }
}

2022-12-05

Changes:

• Fixed managed UI issue of being able to edit a saved condition and not answer all questions.

2019-11-18

Changes:

• Updated button and textbox placeholder text in the managed UI.

2019-03-18

Changes:

• Updated default URL from api.antidotescreening.com to api.cegascreening.com to match package defaults. [UI / JS]

2018-06-21

This release brings API version v1.1.1, a bugfix release. This resolves an issue where it was possible to alter a screening session after it entered the "finalised" state.

Changes:

• Clarified behaviour after the "Finish Screening" endpoint is called. [API]

2018-02-20

This release brings in a new API version: v1.1.0. Since this is not a breaking change, you will not need to do anything as this is automatically the default version of the API.

Added:

• Associated Events [API]
  • This new feature has been added in a backwards compatible manner, if you wish to utilise it you can modify your post request when creating a new screening session and add in the new associatedEvents key as true to the settings object. Example:

{
    "settings": {
        "associatedEvents": true
    }
}

Changes:

• Updated API URL from api.antidotescreening.com to api.cegascreening.com.

2017-12-21

• GET /session/{sessionId} Request
  • Moved from "Advanced" to "Basic" endpoints.
• General [API]
  • Added descriptions to requests, models and parameters, where there were previously none.

2017-12-20

Updated:

• Event Schema [API]
  • Updated recorded_on to recordedAt. This is to conform with existing conventions followed elsewhere in the api.
• ScreeningSession Schema [API]
  • The condition score breakdown now only returns the score key.
• Event CalculatedRisk [API]
  • This event no longer returns data.
• Risk Score Calculation [API]
  • Individual condition scores will return the correct score. Previously this was returning the score -1.
• Search Condition [API]
  • Updated searchTerm to filter[query] to match what the API actually uses.
• POST /screening endpoint [API]
  • Clarified "previousId" usage for re-screening.

2017-11-20

Added:

• Message to prompt reader to contact us for access to the Managed UI implementation. [Implementation Overview | UI / JS]
• screening scope to list of oAuth scopes. [API]

2017-10-26

Initial Release [ALL]