Get Record Status

Introduction

The GetSubmitRecordStatus API should be used after the SubmitRecord API request in order to verify the status of records submitted.. The Record Ids received from the SubmitRecord API request response should be passed as a parameter, one or more record Ids can be passed in the request payload.

Getting Started

All API requests require an authorization token – reference our Authentication page for more information

API Structure

POST api/integration/GetSubmitRecordStatus

Required Request Parameters

Name	Location	Description
Authorization Token	Header	See Login Authentication API documentation
Records	Body	One or more Record Ids can be included in the request
Resource	Body	Resource Name, only one may be selected
Location	Body	Location Name linked to a Resource, only one may be selected

Request JSON Example

{
    "Records": [
        "54C604E6-EB2F-4BF9-9CEB-2B9F2D399929",
        "986A632D-2C85-4C3D-8296-9D611ED849FD"
    ]
}

Response Parameters

Name	Description
RecordId	The RecordID is the GUID generated within SafetyChain and is a unique identifier.
SequenceNo	The SequenceNo indication the position of the record in the SubmitRecord payload.
Status	Either "Failed" or "Successful"
Error	This is the details of the error when the status of "Failed" is return. This will be "null" when the status is "Successful"
RefreshToken	Returns false and is reserved for SCS future use

Response JSON Example

{
    "Data": [{
            "RecordId": "54C604E6-EB2F-4BF9-9CEB-2B9F2D399929",
            "SequenceNo": 1,
            "Status": "Failed",
            "Error": "Invalid Resource name"
        }, {
            "RecordId": "986A632D-2C85-4C3D-8296-9D611ED849FD",
            "SequenceNo": 2,
            "Status": "Successful",
            "Error": null
        }
    ],
    "Status": true,
    "Errors": null,
    "RefreshToken": false
}

📘
Note
The submissions from SubmitRecord are NOT visual in the SafetyChain UI. The GetSubmitRecordStatus must be used to confirm the status of the SubmitRecord call.