You are here:
InsPolicyService:getOutOfSequenceEndorsementStatus
Use this service to retrieve the current status of the OutOfSequenceEndorsement async job. The service accepts jobId, policyId, or referencePolicyNumber as an input to fetch the out-of-sequence endorsement operation status.
Class: InsPolicyService
Method: getOutOfSequenceEndorsementStatus
How It Works
-
The service takes
jobIdorpolicyIdorreferencePolicyNumberas an input parameter. When you pass more than one input parameters in the request, thejobIdtakes precedence, thenpolicyIdand thenreferencePolicyNumber.Important If you pass more than one of the accepted parameters and any one of them is invalid, the service returns an error. -
The service retrieves the current status of the
OutOfSequenceEndorsementprocess. The possible values are:-
WaitingToProcess- The job is in the queue. -
InProgress- The endorsement is in progress. -
Success- The endorsement is successful and new policy versions are created. -
Failed- The endorsement failed. -
Aborted- The admin aborted the operation.
-
-
The service returns the status of latest
jobIdfor a given policy based on thecreatedDate. For example, if a policy has more than two out-of-sequence endorsed in a period, the status of the last out-of-sequence endorsement is returned.
Inputs
You must pass one of these inputs:
| Input | Description |
|---|---|
jobId
|
The async job ID that's returned by OutOfSequenceEndorsement job. |
policyId
|
The policyId of the latest policy version that's endorsed. |
referencePolicyNumber
|
The reference policy number of the endorsed policy. |
Input JSON
Here's the sample input JSON:
{
"jobId": "7075j00004uK6GjAAK"
or
"policyId": "0YT5w000000Y8MNGA0"
or
"referencePolicyNumber" "0YT5w000000Y8MNGA0"
} Output
| Option | Description |
|---|---|
jobId
|
The async job ID for the OutOfSequenceEndorsement process. If you didn't pass a jobId as input and want to know what it is, you can get it from the output. |
status
|
The status of the outOfSequenceEndorsement process. Possible values are: WaitingToProcess, InProgress, Success, Failed, Aborted. |
error
|
The error message that's returned when a job fails. |
Output JSON
Here's the sample output JSON:
{
"status": "Success",
"jobId": "7075j00004uK6GjAAK",
"errorCode": "INVOKE-200",
"error": "OK"
}
