GET api/BatchStatus
Retrieve the 5 most recent Accepted (not yet done) or Complete (done) batch
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
HTTP Status: 200 - OK - Batch[es] Available 401 - Unauthorized - User not authorized 404 - NotFound - No Batch Available
Collection of BatchInstance| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Batch Id |
globally unique identifier |
None. |
| Status |
Batch Status |
string |
None. |
| CreatedDate | date |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Id": "45cfff44-7454-40d3-b33d-5c1f272b2125",
"Status": "sample string 2",
"CreatedDate": "2025-12-18T06:41:41.027583-05:00",
"Message": "sample string 4"
},
{
"Id": "45cfff44-7454-40d3-b33d-5c1f272b2125",
"Status": "sample string 2",
"CreatedDate": "2025-12-18T06:41:41.027583-05:00",
"Message": "sample string 4"
}
]
application/xml, text/xml
Sample:
<ArrayOfBatchInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels">
<BatchInstance>
<CreatedDate>2025-12-18T06:41:41.027583-05:00</CreatedDate>
<Id>45cfff44-7454-40d3-b33d-5c1f272b2125</Id>
<Message>sample string 4</Message>
<Status>sample string 2</Status>
</BatchInstance>
<BatchInstance>
<CreatedDate>2025-12-18T06:41:41.027583-05:00</CreatedDate>
<Id>45cfff44-7454-40d3-b33d-5c1f272b2125</Id>
<Message>sample string 4</Message>
<Status>sample string 2</Status>
</BatchInstance>
</ArrayOfBatchInstance>
multipart/form-data
Sample:
<ArrayOfBatchInstance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NCSI.API.ViewModels"><BatchInstance><CreatedDate>2025-12-18T06:41:41.027583-05:00</CreatedDate><Id>45cfff44-7454-40d3-b33d-5c1f272b2125</Id><Message>sample string 4</Message><Status>sample string 2</Status></BatchInstance><BatchInstance><CreatedDate>2025-12-18T06:41:41.027583-05:00</CreatedDate><Id>45cfff44-7454-40d3-b33d-5c1f272b2125</Id><Message>sample string 4</Message><Status>sample string 2</Status></BatchInstance></ArrayOfBatchInstance>