Deactivate NIBSS Collection Batch

Overview

Returns an Active batch back to Draft status. This allows further modifications such as adding or removing collection items before re-activating and running the batch.

Command Details

• Command: DeactivateNibssCollectionBatchCommand
• Type: Command

API Endpoint

POST /api/bpm/cmd

Request Structure

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

Try It Out

POST/api/bpm/cmdDeactivateNibssCollectionBatchCommand

Base URL

Bearer Token

Request Body

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

Response Structure

{
  "response": {
    "id": 2001,
    "status": "Draft"
  },
  "responseCode": "00",
  "responseDescription": "Batch deactivated successfully"
}

Related Operations

• Activate Batch — Re-activate the batch after modifications
• Add Item to Batch — Add more items while the batch is in draft
• Cancel Batch — Cancel the batch entirely