Margin Service API - Transaction - List

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.

Entity	Transaction
Action	List
URL	`/transactions`
HTTP Method	`GET`
Parameter Input	Yes
XML Input	No
Multiple Output	Yes
Synchronous	Yes

Parameter	Name	Type	Required	Notes
`encoding`	Encoding	Transaction Encoding	No	Defaults to `STRING`
`portfolioId`	Portfolio ID	String	Yes
`reqUserId`	Requesting User ID	String	No
`valid`	Valid	Boolean	No	If specified, limits the request to valid (if true) or invalid (if false) transactions. If not specified, both are returned.

Response

XPath	Name	Type	Required
`/transactionRpt/error@code`	Error Code	String	No
`/transactionRpt/error@msg`	Error Message	String	No
`/transactionRpt/transaction@id`	ID	String	Yes
`/transactionRpt/transaction@portfolioId`	Portfolio ID	String	Yes
`/transactionRpt/transaction@status`	Status	Entity Status	Yes
`/transactionRpt/transaction@type`	Transaction Type	Transaction Type	Yes
`/transactionRpt/transaction/payload@encoding`	Payload Encoding	Transaction Encoding	Yes
`/transactionRpt/transaction/payload@format`	Payload Format	Transaction Format	Yes
`/transactionRpt/transaction/payload/string`	String Payload	String	No

Errors

Code	Description
`500`	The 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>