/getFileDetails

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

  • Service to get Request and Response file Details of one or more accounts. 

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

accountIds

IBKR Client Account Number

List of one or more accounts

Required

JSON Request

Copy 
{
  "CSID":"<client-service-id>",
  "accountIds":[“<ID1>","<ID2>","<ID3>",...]
}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/getFileDetails -d '{"CSID":"testerCSID", "accountIds":["U111118"]}'

Name

Value

Description

Request File Name

FirmName_YYYY-MM-DD_####_####.xml.imported

Filename of the request file

Account ID

IBKR Client Account Number

Account number associated with the request/response file.

Response File Name

FirmName_YYYYMMDD_####_####.xml.report

File name of the response file.

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 
{
  "result" : [ {
    "Account ID" : "<ID1>",
    “BatchID":"<Batch Id>",       
    "Date Begun" : "<Date Begun>",
    "Clearing Status" : "<Status>"
  }, {
    "Account ID" : "<ID2>",       
    "isError" : true,
    "error" : "<Error Description>."
  } ]
}

Sample

Copy

Success

{"result":[{"Request File Name":"Tester_2019-11-26_030758689_953583.xml.imported","Account ID":"U111118","Response File Name":"Tester_20191126-030758834_892713.xml.report"}]}
Copy

Error

{"result":[{"Account ID":"U1234567","isError":true,"error":"U332614 is not associated with your Advisor/iBroker Account."}]}Error - Invalid Account ID