LinX Batch Status Object

The LinX Batch Status object represents an individual LinX workflow request (called an “entry”) within a LinX batch.

Attributes

position

integer

Position of the entry in the batch.

title

string

Name for the LinX workflow used for the batch. This name is used internally and should describe the purpose of the workflow.

string (UUID)

ID of the LinX workflow used for the batch.

status

string enum, values: NEW, QUEUED, COMPLETED, INVALID, CANCELLING, FAILED

Current processing status for the entry. The following values are supported:

NEW New batch has been created.
QUEUED Batch entries (requests) have been queued for creation.
COMPLETED All requests have been executed.
INVALID JSON schema validation failed.
CANCELLING Batch has been cancelled.
FAILED Batch was not processed.

phoneNumber

string

Customer’s mobile phone number. The LinX request is sent to this number via SMS.

errorCode

string

Error code related to any processing errors for the entry.

errorMessage

string

Error message related to any processing errors for the entry.

fieldErrors

array

Error information by field.

fieldName

string

Name of the field.

fieldCategory

string

Field category.

code

string

Error code.

message

string

Error message.

LinX Batch Status Object

				
					{
  "position": integer,
  "title": "string",
  "id": "string(UUID)",
  "status": "NEW | QUEUED | COMPLETED | INVALID | CANCELLING | FAILED",
  "phoneNumber": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "fieldErrors": [
    {
      "fieldName": "string",
      "fieldCategory": "string",
      "code": "string",
      "message": "string"
    }
  ]
}