Jump to

• Request
• Response

Track the status of ingested document

get

/s1-intake-svc/rest/v1.0/integration/status

Retrieves the current status of the ingested document. Used by the Safety One Intake integration.

Request

Query Parameters

• intakeNums(required): string
  Provide the Intake ID of the record you want to track. To track the status of multiple records simultaneously, provide their Intake IDs separated by commas.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object IngestionStatus
  Ingestion Status of the document(s).

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IngestionStatus"
    }
}

Nested Schema : IngestionStatus

Type: object

Ingestion Status of the document(s).

Show Source

• intakeNum: string
  Intake Number of the document.
• Status of the document: string
  Allowed Values: [ "01 - Processing", "02 ??? Invalid - <Reason for Invalid>", "03 - Case Created & Case #<case_number>", "04 - Case merged & Case#<case_number>", "05 - Invalid Intake ID" ]

{
    "type":"object",
    "properties":{
        "intakeNum":{
            "type":"string",
            "description":"Intake Number of the document."
        },
        "Status of the document":{
            "type":"string",
            "enum":[
                "01 - Processing",
                "02 ??? Invalid - <Reason for Invalid>",
                "03 - Case Created & Case #<case_number>",
                "04 - Case merged & Case#<case_number>",
                "05 - Invalid Intake ID"
            ]
        }
    },
    "description":"Ingestion Status of the document(s)."
}

401 Response

Unauthorized user

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

500 Response

Internal server error

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

Back to Top