FetchBatchStatusses

Full path FetchBatchStatusses?ClientID={ClientID}&All={All}
HTTP Verb GET
Description This endpoint expects an HTTP GET request with a ClientID and a FileID.
Requires authentication with an OAuth2 token

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientID

The unique client id

string

Required

All

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

a list of batchstatusses available for this ClientID

Collection of Status
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2"
  },
  {
    "Id": 1,
    "Name": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DocFlowImportServiceInportal.Models">
  <Status>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Status>
  <Status>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </Status>
</ArrayOfStatus>