Page tree
Skip to end of metadata
Go to start of metadata
The list transactions request returns transactions for a portfolio based on search criteria.

Description

The request allows the Client to list the transactions which have already been added to CME CORE (Add Transaction and Update Transaction). The Client can optionally specify the search parameters according to which the server returns the transactions matching the criteria synchronously.


EntityTransaction
ActionList
URL/transactions
HTTP MethodGET
Parameter InputYes
XML InputNo
Multiple OutputYes
SynchronousYes
ParameterNameTypeRequiredNotes
encodingEncodingTransaction EncodingNoDefaults to STRING
portfolioIdPortfolio IDStringYes
reqUserIdRequesting User IDStringNo
validValidBooleanNoIf specified, limits the request to valid (if true) or invalid (if false) transactions. If not specified, both are returned.

Response

XPathNameTypeRequiredNotes
/transactionRpt/error@codeError CodeStringNo
/transactionRpt/error@msgError MessageStringNo
/transactionRpt/transaction@idIDStringYes
/transactionRpt/transaction@portfolioIdPortfolio IDStringYes
/transactionRpt/transaction@statusStatusEntity StatusYes
/transactionRpt/transaction@typeTransaction TypeTransaction Type  Yes
/transactionRpt/transaction/payload@encodingPayload EncodingTransaction EncodingYes
/transactionRpt/transaction/payload@formatPayload FormatTransaction FormatYes
/transactionRpt/transaction/payload/stringString PayloadStringNo

Errors

CodeDescription
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?portfolioId=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> 
  <transaction id="234" portfolioId="1234" status="ERROR" type="TRADE">
    <payload encoding="STRING" format="FIXML">
      <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string>
    </payload>
  </transaction> 
</transactionRpt>
Query for Invalid Transactions
Request
GET /transactions?portfolioId=123&encoding=STRING&valid=false
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:transactionRpt xmlns:ns2="http://cmegroup.com/schema/core/1.2" status="ERROR">
    <error msg="Portfolio ID [123] was not found." code="404"/>
</ns2:transactionRpt>