OGS (ongoingScreeningUpdates) Call Response Content & Triggers

james.russell · February 2020

Hi Dev Community

I am working with a team building an integration with the World-Check One API.

Using our sandbox system I can see updates occuring for profiles that have cases linked to them, but these cases do not appear in the OGS (ongoingScreeningUpdates) call response.

What are the trigger events and contributing data that result in case updates appearing in the response?

Many thanks

Jim.R.

Prabhjyot · February 2020

@james.russell

Thank you for your query.

When you use the API call - 'SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases', you will get the list of caseSystemId which have update during the specified time along with the no. of new matches, the updates for the existing profiles and the date when it was updated. Response snippet below -

 "results": [
        {
            "caseSystemId": "0a3687cf-6542-1d7e-9963-a49e000906ca",
            "numberOfNewResults": 1,
            "numberOfUpdatedResults": 0,
            "updateDate": "2020-01-29T21:52:54.047Z"
        },
        {
            "caseSystemId": "0a3687cf-6c28-192b-9b1c-16650077ce8d",
            "numberOfNewResults": 3,    // New matches for the case
            "numberOfUpdatedResults": 2, // Updates on existing profile in a case
            "updateDate": "2020-01-30T02:47:49.320Z" // Date the case was updated
        }
]

Once you have the details, please use the API call - 'SEQ-case-investigate-results: Get screening results', in order to get the result for the specific caseSystemId. From the results, you will have to check 'modificationDate' of the result's match, which would exactly same as per the 'updateDate' of the API call - 'SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases'.

If you need to further check on the details of the update, please use the API call - 'SEQ-case-investigate-world-check-profile: Get a World-Check profile' for the specific profile which has been updated and the details on the update can be determined via the - 'updateCategory' and 'updatedDates' from the response of the 'Get a World-Check profile'.

Hope this helps.

james.russell · February 2020

Hi Prabhjyot.Mandla

Thankyou, and yes, I understand the call sequence following visibility of updated cases in the response from a 'SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases' call, but within our test system I have cases that are not included in this response that have associated profiles that have been updated.

Is this because the process that determines which cases have updates (the internal re-screening process for OGS) is scheduled with large time intervals on our test system?

If so, this will lead to difficulties with testing for case updates with updated results.

Is there a method of forcing (or simulating) a case update to ensure that it gets included in the 'SEQ-case-monitor-ogs: Monitor ongoing screening updates on cases' response to help with this?

Thanks & regards,

Jim