Page tree

Versions Compared

Key

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

The list portfolios request returns a list of portfolios from the CME CORE database based on search criteria.

Table of Contents
maxLevel4

 

Column
width300px
Align
alignright
EntityPortfolio
ActionList
URL/portfolios
HTTP MethodGET
Parameter InputYes
XML InputNo
Multiple OutputYes
SynchronousYes

Description

The request allows the Client to list all portfolios specified which have been added to CME CORE (Add Portfolio and Update Portfolio). The client can optionally submit the search criteria for only the portfolios and not transactions or other data. The server returns all the portfolios matching the search criteria synchronously.  

Request

ParameterNameTypeRequiredNotes
clrMbrFirmIdClearing Member Firm IDStringNo 
custAcctIdCustomer Account IDStringNo 
reqUserIdRequesting User IDStringNo 

Response

XPathNameTypeRequiredNotes
/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 Yes 
/portfolioRpt/portfolio@updateTimeUpdate TimeDate/TimeYes 
/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.
500The server was not able to process the request. More information (if available) will be provided in the error message.

Examples

Valid

This request queries for all portfolios.  Two portfolios exist in the CME CORE database.

Request
Code Block
languagenone
GET /portfolios
Response
Code Block
languagehtml/xml
linenumberstrue
<portfolioRpt status="SUCCESS">
  <portfolio id="12" name="My Name" desc="My Desc" rptCcy="USD" createTime="2012-12-20 13:12:01" updateTime="2012-12-20 13:14:22">
    <entities clrMbrFirmId="123" custAcctId="ABC" /> 
  </portfolio>
  <portfolio id="13" name="My Other Name" desc="My Other Desc" rptCcy="USD" createTime="2012-12-20 13:13:01" updateTime="2012-12-20 13:13:01">
    <entities clrMbrFirmId="123" custAcctId="DEF" /> 
  </portfolio>
</portfolioRpt>
Valid
Request

This request queries for a single portfolio with Portfolio ID 12.  Only one matching portfolio exists in the CME CORE database.

Code Block
languagenone
GET /portfolios/12
Response
Code Block
languagehtml/xml
linenumberstrue
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:portfolioRpt 
    xmlns:ns2="http://cmegroup.com/schema/core/1.2" status="SUCCESS">
    <portfolio desc="My Desc" name="My Name" rptCcy="USD" id="12" createTime="2014-11-06T10:15:08+00:00" updateTime="2014-11-06T10:15:08+00:00">
        <entities clrMbrFirmId="My Firm" custAcctId="My Account"/>
    </portfolio>
</ns2:portfolioRpt>