Synchronize recheck events

A recheck event is the event that is triggered when an user clicks the check again button in the Compliance-Monitor.

Similar to the changed check results, the compliance API provides two functions to handle these changes:

getChangedRecheckEvents
acknowledgeChangedRecheckEvents

getChangedRecheckEvents

The function getChangedRecheckEvents can be used to fetch the events.

API	Function
REST	POST getChangedRecheckEvents
SOAP	ComplianceBF (WSDL) \| getChangedCheckResults (JavaDoc)

The function expects the system id of the pre-system, the BSM client and an username

{
  "clientSystemId": "BRUYES",
  "clientIdentCode": "SAP_JNH_080",
  "userName": "API_TEST",
  "resultLanguageIsoCodes": [
    "en"
  ],
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:getCheckResult>
         <request>
            <clientSystemId>BRUYES</clientSystemId>
            <clientIdentCode>SAP_JNH_080</clientIdentCode>
            <userName>API_TEST</userName>
            <resultLanguageIsoCodes>en</resultLanguageIsoCodes>
         </request>
      </urn:getCheckResult>
   </soapenv:Body>
</soapenv:Envelope>

The result returns all business objects for which the check again button was clicked:

{
  "hasErrors": false,
  "hasOnlyRetryableErrors": false,
  "hasWarnings": false,
  "messages": [],
  "syncId": "354",
  "isComplete": true,
  "recheckEvents": [
    {
      "boIdClientSystem": "SAP_JNH_080_SALES_ORDER_32",
      "boIdClientSystemLabel": "SAP JNH 080 Sales order 32",
      "referenceNumber": "32"
    }
  ]
}

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:getChangedRecheckEventsResponse xmlns:ns2="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
            <result>
                <hasErrors>false</hasErrors>
                <hasOnlyRetryableErrors>false</hasOnlyRetryableErrors>
                <hasWarnings>false</hasWarnings>
                <syncId>354</syncId>
                <isComplete>true</isComplete>
                <recheckEvents>
                    <boIdClientSystem>SAP_JNH_080_SALES_ORDER_32</boIdClientSystem>
                    <boIdClientSystemLabel>SAP JNH 080 Sales order 32</boIdClientSystemLabel>
                    <referenceNumber>32</referenceNumber>
                </recheckEvents>
            </result>
        </ns2:getChangedRecheckEventsResponse>
    </S:Body>
</S:Envelope>

After you handled the event you can use the syncId to confirm it.

acknowledgeChangedRecheckEvents

Similar to the check results, the function can be used to acknowledge the recheck events.

API	Function
REST	POST acknowledgeChangedRecheckEvents
SOAP	ComplianceBF (WSDL) \| acknowledgeChangedRecheckEvents

To call the function, you need to provide the system id of the pre-system, the BSM client, a username and the syncId that is provided by the response of the getChangedRecheckEvents function.

{
  "clientSystemId": "BRUYES",
  "clientIdentCode": "SAP_JNH_080",
  "userName": "API_TEST",
  "resultLanguageIsoCodes": [
    "en"
  ],
  "syncId": "354"
}

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:acknowledgeChangedRecheckEvents>
         <request>
            <clientSystemId>BRUYES</clientSystemId>
            <clientIdentCode>SAP_JNH_080</clientIdentCode>
            <userName>API_TEST</userName>
            <resultLanguageIsoCodes>en</resultLanguageIsoCodes>
            <syncId>354</syncId>
         </request>
      </urn:acknowledgeChangedRecheckEvents>
   </soapenv:Body>
</soapenv:Envelope>

The result will look like the response body below:

{
  "hasErrors": false,
  "hasOnlyRetryableErrors": false,
  "hasWarnings": false,
  "messages": []
}

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns2:acknowledgeChangedRecheckEventsResponse xmlns:ns2="urn:de.aeb.xnsg.bsm.compliance.bf.checkrequest">
            <result>
                <hasErrors>false</hasErrors>
                <hasOnlyRetryableErrors>false</hasOnlyRetryableErrors>
                <hasWarnings>false</hasWarnings>
            </result>
        </ns2:acknowledgeChangedRecheckEventsResponse>
    </S:Body>
</S:Envelope>