Ongoing Screening Alerts Workflow ?
Hello,
Could you please confirm the following : The OGS can be enabled via API via a request and the API administrator will receive an email if any update happened telling him to check the cases for an update.
If true, I have three questions:
- What is the request I should do, via the API, to get the case that was updated ?
- is there any way to be updated via the API in addition to the sent mail ? If yes what is the request and workflow ?
Best Regards
You will have to use the API call "SEQ-6a: Enable ongoing screening for a case." in order to enable OGS for a screened case.
In order to check the case which has been updated, you need to call the API call - "SEQ-9: Monitor ongoing screening updates on cases", where you have to manually update the content of the Body before calling the API call, with the date when you have received the alert.
For example, if you have received an email update for an OGS on 28th May 2018, then you will have to edit the body of the "SEQ-9" from { "query": "updateDate>='{ {weekAgo}}'" } to { "query": "updateDate>='2018-05-28'" } and then call the API to view the result. The result should display the details of the updated OGS case as on that date.
Just for calrification - Below is a sample workflow which you may follow:
Step 1: SEQ-2b: Save a very simple case
Step 2: SEQ-4a: Screen a case
Step 3: SEQ-6a: Enable ongoing screening for a case
Step 4: SEQ-8: Retrieve the audit log for a case
Step 5: SEQ-9: Monitor ongoing screening updates on cases
Hope this clarifies your concern.
You should receive email alerts for the OGS, as and when the case is updated. There is no specific API call to enable it.
- In order to check updates via email for any OGS, use the API call - "SEQ-9: Monitor ongoing screening updates on cases". You should receive email notification as and when the case has been updated.
- There is no way to be updated via API call in addition of email notification.
Hello
Thank you for your answer.
The OGS is not automatically enabled for every screened name. So you must enable it, how do you do that ?
The mail received does not contain the information on the updated case, so how do you find the right case and also all the updated cases via the Api ? What is the workflow?
Besr regards
Hi,
To finish the workflow:
The Json output of SEQ 9: can be
{
"caseSystemId": "0a3687cf-5e81-1702-97a8-06050005be8c",
"numberOfNewResults": 6,
"numberOfUpdatedResults": 15,
"updateDate": "2018-10-07T06:23:57.938Z"
},
{
"caseSystemId": "0a3687d0-5e81-1e6e-97a8-3fb100004eba",
"numberOfNewResults": 0,
"numberOfUpdatedResults": 1,
"updateDate": "2018-10-07T06:23:58.280Z"
},
What is the meaning of numberOfNewResults and numberOfUpdatedResults ?
By applying "SEQ-5b: Get screening results" with the CaseSystemId we will get the ongoing screening results, right ?
Best Regards
Hi,
I found the answer in the documentation:
Name Description Schema caseSystemIdrequired System generated ID for the Case string numberOfNewResults
optional Number of new results added to the Case identified by caseSystemId during the ongoing screening operation that this update belongs to. integer(int32) numberOfUpdatedResults
optional Number of updates in the existing results of the Case identified by caseSystemId found during the ongoing screening operation that this update belongs to. integer(int32) updateDate
required Creation date and time of this ongoingScreeningUpdate in ISO 8601 format excluding Week and Ordinal dates. string(date-time)
Best Regards