Margin Service API - Portfolio - Update



Description

The request allows the Client to update a portfolio which has already been added to CME CORE (Add Portfolio). The client must the unique CME CORE -assigned internal portfolio identifier in the request URL. The transactions have to be submitted separately. If the portfolio with the identifier isn't fond, an error is returned. An error is also returned when the user isn't authorized to modify the portfolio. If the request is valid and successful, then the internal identifier along with the current status is returned.   

Request

XPath

Name

Type

Required

Notes

XPath

Name

Type

Required

Notes

/portfolioReq@reqUserId

Requesting User ID

String

No



/portfolioReq/portfolio@desc

Description

String

No



/portfolioReq/portfolio@id

Portfolio ID

String 

Yes



/portfolioReq/portfolio@name

Name

String 

No



/portfolioReq/portfolio@rptCcy

Reporting Currency

String 

No

Defaults to USD.

/portfolioReq/portfolio/entities@clrMbrFirmId

Clearing Member Firm ID

String 

No



/portfolioReq/portfolio/entities@custAcctId

Customer Account ID

String 

No



Response

XPath

Name

Type

Required

Notes

XPath

Name

Type

Required

Notes

/portfolioRpt@status

Status

Sync Report Status

Yes



/portfolioRpt/error@code

Error Code

String 

No



/portfolioRpt/error@msg

Error Message

String 

No



/portfolioRpt/portfolio@createTime

Create Time

Date/Time

Yes



/portfolioRpt/portfolio@desc

Description

String 

No



/portfolioRpt/portfolio@id

Portfolio ID

String 

Yes



/portfolioRpt/portfolio@name

Name

String 

No



/portfolioRpt/portfolio@rptCcy

Reporting Currency

String 

No



/portfolioRpt/portfolio@status

Entity Status

Entity Status

Yes



/portfolioRpt/portfolio@updateTime

Update Time

Date/Time 

Yes



/portfolioRpt/portfolio/entities@clrMbrFirmId

Clearing Member Firm ID

String 

Yes



/portfolioRpt/portfolio/entities@custAcctId

Customer Account ID

String 

Yes



Errors

Code

Description

Code

Description

400

Bad XML syntax or missing content. More information will be provided in the error message.

403

Returned if the user does not have permission to update the specified portfolio.

404

Returned if the requested portfolio 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

Valid
Request
PUT /portfolios/123 



<portfolioReq> <portfolio id="123" name="My Name" desc="My Desc" rptCcy="USD"> <entities clrMbrFirmId="ABC" custAcctId="123" /> </portfolio> </portfolioReq>
Response
<portfolioRpt status="SUCCESS"> <portfolio id="123" name="My Name" desc="My Desc" rptCcy="USD" createTime="2012-12-20 13:12:01" updateTime="2012-12-20 13:14:22" status="UPDATED"> <entities clrMbrFirmId="ABC" custAcctId="123" /> </portfolio> </portfolioRpt>






How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.