Delta API

Note: This API is required as part of the integration.

Try it: Here

POST	/_c/std/api/DeltaAPI.aspx	Manages the carrier update queue.

API Summary

Definitions

• Delta – A changed insured record in the RMIS system. This can be a brand-new record for the client, or an existing record that has had updates made to the underlying data and needs to be synchronized between RMIS and the client.
• Insured - This refers to a carrier that is being monitored
• RMIS ID/Insured ID - The RMIS specific identifier for a carrier -- This is the value that will be returned in the Delta API Fetch call

Purpose

The purpose of the Delta API is to allow brokers to quickly identify newly onboarded and recently updated carriers in their monitored carrier network.

Understanding the Delta API

The Delta API works as a three-part system: Summary, Fetch, then Clear. Below is a diagram depicting the proper flow.

📘

Delta API Flow Diagram

---

Delta API Modes

Mode: Summary

📘

### Summary

Calling the Delta API with the mode of summary will return an integer value of the number of carriers present in the Delta Queue that are waiting for processing.

Request

curl --request POST \
     --url https://api.rmissecure.com/_c/std/api/DeltaAPI.aspx \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ClientID": "**YourClientID**",
  "ClientPassword": "**YourPassword**",
  "APIMode": "Summary"
}
'

Response

{
  "RMISDeltaAPI": {
    "Header": {
      "TimeStamp": "2024-09-25T20:08:10.3040158Z",
      "API": "DeltaAPI",
      "APIMode": "SUMMARY",
      "APIVersion": "1",
      "Result": "SUCCESS"
    },
    "SUMMARY": {
      "TotalInsdIDs": "1",
      "MinTimeStamp": "2024-09-22T17:59:02.583Z"
    }
  }
}

Mode: Fetch

📘

### Fetch

Calling the Delta API with the mode of Fetch will return the top N carriers from the Delta Queue in a list format in the response with N being the value you specify in the MaxRecs field.

Notes:

• The same Insured ID will never be returned more than once per call (de-duplicated list)
• The list will consist of insureds that are either new to the client or insureds that have had changes since the last Fetch and Clear cycle.

Request

curl --request POST \
     --url https://api.rmissecure.com/_c/std/api/DeltaAPI.aspx \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "MaxRecs": "50",
  "ClientID": "**YourClientID**",
  "ClientPassword": "**YourPassword**",
  "APIMode": "Fetch"
}
'

Response

{
  "RMISDeltaAPI": {
    "Header": {
      "TimeStamp": "2024-09-25T20:03:15.0507299Z",
      "API": "DeltaAPI",
      "APIMode": "FETCH",
      "APIVersion": "1",
      "Result": "SUCCESS"
    },
    "FETCH": {
      "InsdID": [
        "1222797"
      ]
    }
  }
}

Mode: Clear

📘

### Clear

Calling the Delta API with the mode of Clear will remove the specified carriers from the delta queue. This call is made up of two parts per carrier being cleared

• The insured (RMIS) id of the carrier obtained in the Fetch call
• The timestamp from the header response of the Expanded Carrier API

Request

curl --request POST \
     --url https://api.rmissecure.com/_c/std/api/DeltaAPI.aspx \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "ClearInsureds": [
    {
      "insdID": 1222797,
      "timeStamp": "2024-09-25T20:11:12.8642279Z"
    }
  ],
  "ClientID": "**YourClientID**",
  "ClientPassword": "**YourPassword**",
  "APIMode": "Clear"
}
'

Response

{
  "RMISDeltaAPI": {
    "Header": {
      "TimeStamp": "2024-09-25T20:11:46.9022131Z",
      "API": "DeltaAPI",
      "APIMode": "CLEAR",
      "APIVersion": "1",
      "Result": "SUCCESS"
    },
    "CLEAR": {
      "Insured": {
        "InsdID": "1222797",
        "Result": "Success"
      }
    }
  }
}

Parallel Processing

The Delta mode of Fetch has a built-in ‘visibility time-out’ feature to assist with parallel processing. When the Delta API Fetch is called, and a set of insured IDs is returned, that set of IDs will become invisible to the API for 120 seconds.

If the Delta API FETCH is called again immediately after, the original set of insured IDs will NOT be returned, instead, If there are more IDs in the queue, the next set of IDs in the list will be returned.

If the FETCH is called after the 120 second visibility time-out, and the insured(s) have not been cleared from the queue with the CLEAR call, those IDs will be returned again.