/getResponseFile

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

  • Service to pull response file by external_id. 

  • HTTP Request Type: POST

Name

Value

Description

Usage

CSID

Client Service ID

Unique identifier issued by Interactive Brokers.

 

Required

externalId

String

external_id included within the XML Application that was previously submitted using /create endpoint.

Required

JSON Request

Copy 
{
  "CSID":"<client-service-id>",
  "externalId":[“<externalIDofApplicationHere>"
}

Sample

Copy 
curl -k -H "Content-Type:application/json" -X POST https://[domain]/ws/eca/getResponseFile -d '{"CSID":"testerCSID", "externalId":"anagyIndiApplication"}'Sample:

Name

Value

Description

timestamp

YYYY-MM-DD HH:MM:SS

Date/Time which the request was processed at.

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" : [ {
    "isProcessed": “<true or false>",
    “timestamp":"<YYYY-MM-DD HH:MM:SS>",       
    "isError" : "<true or false>",
    "error" : "<only appears if is_error ="true">",
    "Clearing Status" : "<Status>"
  }, {
    "name" : "<Response File Name Here>",       
    "isError" : true,
    "error" : "<Error Description>."
  } ]
}

Sample

Copy 
{"name":"TesterFA_20200503-6546546"}, “isProcessed":true, “timestamp": “2020-05-11 14:18:18"} Success 
Error – Invalid External ID. 
{"name":"TesterFA_20200503-6546546"}, “isError":true,"error":"You are not authorized to view the response file associated with this external id", External ID":"FR_OLD_StateCOde"}