Page tree
Skip to end of metadata
Go to start of metadata
The get margin request returns the transaction by its identifier.

 

EntityTransaction
ActionGet
URL/transactions/{id}
HTTP MethodGET
Parameter InputYes
XML InputNo
Multiple OutputNo
SynchronousYes

Description

The request allows the Client to retrieve the contents of a transaction which was already added to CORE (Add Transaction and Update Transaction). The must submit the unique CORE-assigned internal transaction identifier in the request URL. If the requested transaction does not exist with the identifier or if the client is not authorized to get the transaction then an error is returned. The server will return the requested transaction to the Client if valid and if the transaction is found.  

Request

ParameterNameTypeRequiredNotes
encodingEncodingTransaction EncodingNoDefaults to STRING
reqUserIdRequesting User IDStringNo 

Response

XPathNameTypeRequiredNotes
/transactionRpt/error@codeError CodeStringNo 
/transactionRpt/error@msgError MessageStringNo 
/transactionRpt/transaction@idIDStringYes 
/transactionRpt/transaction@createTimeCreate TimeDate/TimeYes 
/transactionRpt/transaction@portfolioIdPortfolio IDString Yes 
/transactionRpt/transaction@statusStatusEntity StatusYes 
/transactionRpt/transaction@typeTransaction TypeTransaction Type Yes 
/transactionRpt/transaction@updateTimeUpdate TimeDate/Time Yes 
/transactionRpt/transaction/payload@encodingPayload EncodingTransaction EncodingYes 
/transactionRpt/transaction/payload@formatPayload FormatTransaction FormatYes 
/transactionRpt/transaction/payload/stringString PayloadString No 

Errors

CodeDescription
403Returned if the user does not have permission to access the specified portfolio.
404Returned if the requested transaction could not be found.
500The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Basic
Request
GET /transactions/123?encoding=STRING
Response
<transactionRpt>
  <transaction id="123" portfolioId="1234" status="UPDATED" type="TRADE">
    <payload encoding="STRING" format="FIXML">
      <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string>
    </payload>
  </transaction> 
</transactionRpt>
  • No labels