How to handle timing before executing the request to retrieve the results ?

nabil.hassoumi
nabil.hassoumi LSEG
in World-Check One

Hello,

What is the best solution to handle/manage the time needed for screening results ? Indeed, if we call the service

« https://rms-world-check-one-api-pilot.thomsonreuters.com/v1/cases/{{case-system-id}}/results »

too early we do not get any result. How can we ensure that we are doinf it at the right time ?

Best Regards

Tagged:

Best Answer

  • Irfan.Khan
    Irfan.Khan LSEG
    Answer ✓

    Hello @nabil.hassoumi ,

    The client can call the API "SEQ-8: Retrieve the audit log for a case" using the case system ID and check for the keyword "actionType" and it is related value in the JSON response body sent by our WC1 API.

    If the key "actionType" has the value "SCREENED_CASE", the user can be sure that the case has been screened successfully. Then they can call the endpoint "results" (SEQ-5b: Get screening results) to get the list of all the results in the case.

    Please find the sample JSON response received when the API "SEQ-8: Retrieve the audit log for a case" is called. I have highlighted the key "actionType" which should be looked at to know if the case is screened or not.

    {
    "query": "actionType==SCREENED_CASE;actionedByUserId==0a3687cf-611f-145c-9866-5974000011c2;eventDate>2010-01-01T00:00:00Z;eventDate<2020-01-01T00:00:00Z",
    "sort": null,
    "totalResultCount": 1,
    "pagination": {
    "currentPage": 1,
    "itemsPerPage": 100,
    "totalItems": 1
    },
    "results": [
    {
    "id": "0a3687d0-61fc-1162-9887-845a0004ea82",
    "objectId": "0a3687cf-61fc-174c-9887-84310000ec7d",
    "eventDate": "2018-03-13T06:34:40.873Z",
    "actionedByUserId": "0a3687cf-611f-145c-9866-5974000011c2",
    "actionedByUserName": "Irfan Khan",
    "note": null,
    "entityType": "CASE",
    "actionType": "SCREENED_CASE",
    "auditEventToDate": null,
    "details": {
    "detailsType": "ScreenCaseAuditDetails",
    "userId": null,
    "statusCode": "COMPLETED",
    "screeningState": "INITIAL",
    "noOfNewResults": 0,
    "noOfReviewRequiredResults": 0,
    "noOfExcludedResults": 0,
    "noOfAutoResolvedResults": 0,
    "providerTypes": [
    "WATCHLIST"
    ],
    "caseScreenRequestor": null,
    "caseSystemId": "0a3687cf-61fc-174c-9887-84310000ec7d"
    }
    }
    ]
    }

    Kindly note the "actionType" give ENUM values and can have different values at different times depending on the state of the case. So the client should search for the exact value "SCREENED_CASE" to confirm if the case has been screened. It is advised to always include the filter "query" : "actionType==SCREENED_CASE;" in the request body when sending the Seq 8 API request so that only screened cases are displayed as results.

Categories