/getStatus

https://[domain]/ws/eca/getStatus

If you misplace the response file (but stored the batch ID), you can reference the batch ID to pull the response file again
HTTP Request Type: POST

Request Parameters

Name	Value	Description	Usage
CSID	Client Service ID	Unique identifier issued by Interactive Brokers.	Required
batchId	BatchId issued by IBKR for a given request.	When you receive the response, you will receive a batch ID.	Required

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

Required

batchId

BatchId issued by IBKR for a given request.

When you receive the response, you will receive a batch ID.

Required

JSON Request

Copy

CSID=<client-service-id>&batchId=<batch-id>

Sample

Copy

curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/getStatus -d '{"CSID":"testerCSID", "batchId":"615007"}'

Response Parameters

Name	Value	Description
fileData	fileData section will provide details in an encrypted XML file, encoded in base64.	Only included if isProcessed= TRUE
name	Response-file name	Only included if isProcessed= TRUE
data	Encrypted response XML, encoded in base64	Only included if isProcessed= TRUE
isProcessed	Boolean	Indicate whether the request has been processed or not. In case request has been processed
timestamp	YYYY-MM-DD HH:MM:SS	Date/Time which the request was processed at.
dateSubmitted	YYYY-MM-DD HH:MM:SS	Date/time request was submitted at.
isError	Boolean	Indicates if there was an error when processing the request.
Error	String AND only populated if isError="true"	Description of error.

JSON Response

Copy

{
  "timestamp": "<timestamp>",
  "dateSubmitted","<date-submitted>",
  "isProcessed":"<true|false>",
  "fileData":" {
    "name":"<response-file-name>",
    "data":"<encrypted response XML, encoded in base64>"
  }
}

Sample

Copy

Success

{"fileData":{"data":"hQIMA/mOMVbs3nc3ARAAn39g5AhKKwNVnWjzOSCpH1e+d7FJ2rb6aBMB/e8X8oTxiA2PXvl8POLNWcu3Ka1tDMpuC9b47FM8g3/UjGDqP+/GRrLj9tJz89/R5BNmrcrAn5YUmRcYcsJxd3ELB7G/TcFqI8=",
"name":"/home/users/aces/eca_ws/20190806/tester/tester_20190806-191400542_208107.xml.report"},
"isProcessed":true,
"dateSubmitted":"2019-08-06 19:14:00",
"timestamp":"2020-02-10 09:59:32"}

Copy

Error

{"error":"You are NOT Authorized to see Status for the given Batch Id"}Error- Invalid BatchID