Activate NIBSS Collection Batch

Overview

Transitions a collection batch from Draft to Active status. An active batch is ready for execution via the Run Batch command. The batch must contain at least one collection item before it can be activated.

Command Details

• Command: ActivateNibssCollectionBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

Field	Type	Required	Description
batchId	long	Yes	ID of the collection batch to activate

Try It Out

POST/api/bpm/cmdActivateNibssCollectionBatchCommand

Base URL

Bearer Token

Request Body

{ "cmd": "ActivateNibssCollectionBatchCommand", "data": { "batchId": 2001 } }

Response Structure

{
  "response": {
    "id": 2001,
    "status": "Active"
  },
  "responseCode": "00",
  "responseDescription": "Batch activated successfully"
}

Related Operations

• Deactivate Batch — Return the batch to draft status
• Run Batch — Execute the active batch
• Cancel Batch — Cancel the batch instead of running it