Margin Service API - Transaction - Update

The update transaction request updates attributes of an existing transaction in the CME CORE database.

Description

The request allows the Client to update an already added transaction to CME CORE (Add Transaction). Multiple transactions can be updates in a single request using this request where transactions can be created, updated and deleted but to a single portfolio. The Client must specify the unique CME CORE-assigned portfolio identifier. For every transaction created the required attributes must be specified. For every transaction being updated the required attributes along with the system internal identifier must be specified. And for every transaction deleted, the internal identifier of the transaction must be specified. The server will return a request identifier which can be used for tracking status.

Multiple transactions can be updated within one message. If processingMode="COMPLETE" then all transactions must pass validation, or none will be updated. If processingMode="PARTIAL" then transactions that are invalid will not be updated, but any valid transactions will be unaffected. Should this happen, the response will have /transactionRpt@status="SUCCESS_WITH_ERRORS" and /transactionRpt/transaction/error@code and /transactionRpt/transaction/error@msg present for each transaction that failed.

Entity	Transaction
Action	Update
URL	`/transactions/{id}`
HTTP Method	PUT
Parameter Input	No
XML Input	Yes
Multiple Output	No
Synchronous	Yes

Request

XPath	Name	Type	Required
`/transactionReq@reqUserId`	Requesting User ID	String	No
`/transactionReq@processingMode`	Processing Mode	Processing Mode	No
`/transactionReq/transaction@id`	ID	String	Yes
`/transactionReq/transaction@portfolioId`	Portfolio ID	String	Yes
`/transactionReq/transaction@type`	Transaction Type	Transaction Type	Yes
`/transactionReq/transaction/payload@encoding`	Payload Encoding	Transaction Encoding	Yes
`/transactionReq/transaction/payload@format`	Payload Format	Transaction Format	Yes
`/transactionReq/transaction/payload/string`	String Payload	String	Yes

Response

XPath	Name	Type	Required
`/transactionRpt@status`	Status	Sync Report Status	Yes
`/transactionRpt/error@code`	Error Code	String	No
`/transactionRpt/error@msg`	Error Message	String	No
`/transactionRpt/transaction@createTime`	Create Time	Date/Time	Yes
`/transactionRpt/transaction@id`	ID	String	Yes
`/transactionRpt/transaction@portfolioId`	Portfolio ID	String	Yes
`/transactionRpt/transaction@status`	Entity Status	Entity Status	Yes
`/transactionRpt/transaction@type`	Transaction Type	Transaction Type	Yes
`/transactionRpt/transaction@updateTime`	Update Time	Date/Time	Yes
`/transactionRpt/transaction/error@code`	Error Code	String	No
`/transactionRpt/transaction/error@msg`	Error Message	String	No
`/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	Yes

Errors

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

Examples

Basic

Request

PUT /transactions/{transaction id}

<transactionReq>
  <transaction id="123" portfolioId="1234" type="TRADE">
    <payload encoding="STRING" format="FIXML">
      <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string>
    </payload>
  </transaction>
</transactionReq>

Response

<transactionRpt>
  <transaction id="123" portfolioId="1234" type="TRADE" createTime="2013-01-09 10:01:02" updateTime="2013-01-09 10:02:10" status="UPDATED">
    <payload encoding="STRING" format="FIXML">
      <string><![CDATA[<FIXML><!-- TrdCaptRpt goes here --></FIXML>]]></string>
    </payload>
  </transaction>
</trsansactionRpt>