Margin Service API - Transaction - Add

The add transaction request creates a new transaction in the CME CORE database.

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

Description

This request allows the Client to add or create a new transaction in CME CORE. The Client must submit the required attributes (specified below) for a new transaction, then the server validates the request. If the request is invalid, the server returns a status and an error message/code and if the request is valid, an internal identifier for the request along with the status are returned.

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

Request

XPath	Name	Type	Required	Notes

XPath	Name	Type	Required
`/transactionReq@reqUserId`	Requesting User ID	String	No
`/transactionReq@processingMode`	Processing Mode	Processing Mode	No
`/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	Notes

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