Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
Excerpt

The update portfolio request updates attributes of an existing portfolio into the CME CORE database.

Table of Contents
maxLevel4

 

Column
width300px
Align
alignright
EntityPortfolio
ActionUpdate
URL/portfolios/{id}
HTTP MethodPUT
Parameter InputNo
XML InputYes
Multiple OutputNo
SynchronousYes

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

XPathNameTypeRequiredNotes
/portfolioReq@reqUserIdRequesting User IDStringNo 
/portfolioReq/portfolio@descDescriptionStringNo 
/portfolioReq/portfolio@idPortfolio IDString Yes 
/portfolioReq/portfolio@nameNameString No 
/portfolioReq/portfolio@rptCcyReporting CurrencyString NoDefaults to USD.
/portfolioReq/portfolio/entities@clrMbrFirmIdClearing Member Firm IDString No 
/portfolioReq/portfolio/entities@custAcctIdCustomer Account IDString No 

Response

XPathNameTypeRequiredNotes
/portfolioRpt@statusStatusSync Report StatusYes 
/portfolioRpt/error@codeError CodeString No 
/portfolioRpt/error@msgError MessageString No 
/portfolioRpt/portfolio@createTimeCreate TimeDate/TimeYes 
/portfolioRpt/portfolio@descDescriptionString No 
/portfolioRpt/portfolio@idPortfolio IDString Yes 
/portfolioRpt/portfolio@nameNameString No 
/portfolioRpt/portfolio@rptCcyReporting CurrencyString No 
/portfolioRpt/portfolio@statusEntity StatusEntity StatusYes 
/portfolioRpt/portfolio@updateTimeUpdate TimeDate/Time Yes 
/portfolioRpt/portfolio/entities@clrMbrFirmIdClearing Member Firm IDString Yes 
/portfolioRpt/portfolio/entities@custAcctIdCustomer Account IDString Yes 

Errors

CodeDescription
400Bad XML syntax or missing content. More information will be provided in the error message.
403Returned if the user does not have permission to update the specified portfolio.
404Returned if the requested portfolio could not be found.
500The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Valid
Request
Code Block
languagenone
PUT /portfolios/123 
Code Block
languagehtml/xml
linenumberstrue
<portfolioReq>
  <portfolio id="123" name="My Name" desc="My Desc" rptCcy="USD">
    <entities clrMbrFirmId="ABC" custAcctId="123" /> 
  </portfolio>
</portfolioReq>
Response
Code Block
languagehtml/xml
linenumberstrue
<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>