Get Insurance Policy Current Standings Action

Get the current standings of the insurance policy.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/getInsPolicyCurrentStandings

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input Type Description
getInsPlcyCurrStndInputRep Apex-defined Required. An Apex ConnectApi.GetInsPlcyCurrStndInputRep record that contains the details to retrieve the consumed and available limits for the policy or claim.

Outputs

Output Type Description
getInsPlcyCurrStndOutputRep Apex-defined An Apex ConnectApi.GetInsPlcyCurrStndOutputRep record that contains the details of the consumed and available limits that are retrieved for the policy claim.

Example

Sample Request

{
  "inputs": [
    {
      "getInsPlcyCurrStndInputRep": {
        "policyId": "01t000000000000001",
        "claimId": null,
        "policyParticipantId": null,
        "policyAssetId": null,
        "policyCoverageId": null,
        "claimCoverageId": null,
        "options": {
          "viewOption": "showAllPolicyCoverages",
          "shouldIncludePendingAmount": true
        }
      }
    }
  ]
}

Sample Response

[
  {
    "actionName": "getInsPolicyCurrentStandings",
    "errors": null,
    "invocationId": null,
    "isSuccess": true,
    "outcome": null,
    "outputValues": {
      "getInsPlcyCurrStndOutputRep": [
        {
          "iplStandingCalcOutputNodes": [
            {
              "amounts": {
                "initialAmount": 500,
                "pendingAmount": 25,
                "predictedRemainingAmount": 325,
                "remainingAmount": 350,
                "totalUsedAmount": 150
              },
              "coverageInfo": {
                "claimCoverageId": "1TDSG0000007HU84AM",
                "claimId": "0cYSG000000UYlq2AG",
                "policyAssetId": "0cYSG000000UYzt2XY",
                "policyCoverageId": "0cYSG000000UYlq2AG",
                "policyParticipantId": "sdfbdsf976sff",
                "subCoverageName": "auto-parts"
              },
              "limitAttributes": {
                "applicableAction": [
                  "PaymentAttempted"
                ],
                "durationType": "PolicyTerm",
                "category": "LimitCurrency",
                "policyLimitStandingKey": "PolicyCover LimitCurrency"
              },
              "mappedScopes": {
                "parentMappedScopeId": "a0MS70000004oVfIAI",
                "prodtAttrMappedScopeId": "a0MS70000004oVgIAI"
              },
              "values": {
                "initialValue": 10000,
                "pendingValue": 500,
                "predictedRemainingValue": 8000,
                "remainingValue": 8500,
                "totalUsedValue": 1500
              }
            }
          ]
        }
      ]
    },
    "sortOrder": -1,
    "version": 1
  }
]