Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get All Models

This request returns the list of programs (including third party programs to which you have been granted access) that contain lists of models to which folios in member’s brokerage accounts can be subscribed.

Request URL

Syntax GET /restapi/models
Example URL https://api.uat.foliofn.com/restapi/models

Response Data Fields

Field Description
programDescription The description of the program.
programName The name of the program.
programOid The unique identifier of the program.
models An Array of models. See Models Response Data Fields below.

Models Response Data Fields

Field Description
URL HTTP address of more info on the model manager.
benchmarkItem The model’s benchmark benchmark. Can be a ticker symbol or an index symbol. Optional. Custom benchmarks are not supported by the REST API at this time.
cashSecurity Security used in the folio as the cash equivalent. 43440 is FDIC.CASH
description The description of the model.
firmName The firm name that manages the model.
folioName The name of the model folio.
folioOid The unique identifier of the model folio.
iaFirstName The first name of the advisor that creates the model.
iaLastName The last name of the advisor that creates the model.
iaMemberOid The unique identifier of the advisor that creates the model.
longName The longer version of the name of the model.
modelOid The unique identifier of the model.
programOid The unique identifier of the program.
style The style of a model. See Model Style Codes for detail.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/models
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 05 Aug 2014 19:05:30 GMT
[
{
  "models" : [ {
    "URL" : "",
    "cashSecurity" : "0",
    "benchmarkItem" : "IYY "
    "description" : "",
    "firmName" : "API Sample Firm",
    "folioName" : "folio name",
    "folioOid" : "4646464646464646464646",
    "iaFirstName" : "FirstName ",
    "iaLastName" : "LastName ",
    "iaMemberOid" : "65656565656565656565",
    "longName" : "Test",
    "modelOid" : "36363636363636363636",
    "programOid" : [ "333333333333333333333" ],
    "style" : "NC"
  } ],
  "programDescription" : "Firm Default Program",
  "programName" : "Firm",
  "programOid" : "333333333333333333333"
}, {
  "models" : [ {
    "URL" : "",
    "cashSecurity" : "0",
    "benchmarkItem" : "EFA "
    "description" : "Aggressive growth stocks ...",
    "firmName" : " API Sample Firm ",
    "folioName" : "Very Aggresive Growth",
    "folioOid" : "22222222222222222222",
    "iaFirstName" : "FirstName ",
    "iaLastName" : "LastName ",
    "iaMemberOid" : "44444444444444444444",
    "longName" : "Aggressive Growth",
    "modelOid" : "56565656565656565",
    "programOid" : [ "333333333333333333333" ],
    "style" : "LG"
  }, {
    "URL" : "",
    "cashSecurity" : "0",
    "benchmarkItem" : "^SPX "
    "description" : "",
    "firmName" : " API Sample Firm ",
    "folioName" : "folio name",
    "folioOid" : "464646464646464646464",
    "iaFirstName" : "FirstName ",
    "iaLastName" : "LastName",
    "iaMemberOid" : "6565656565656565656",
    "longName" : "Test",
    "modelOid" : "63636363636363636363",
    "programOid" : [ "4444444444444444444" ],
    "style" : "NC"
  } ],
  "programDescription" : "For Document",
  "programName" : "Demo",
  "programOid" : "4444444444444444444"
}
]


Change Log

08/19/2016

  1. Updated Page Name and Description
  2. Added Models Response Data Fields

08/05/2016

  1. Updated Response Example

04/29/2016

  1. Added Change Log

09/20/2016

  1. Added new field benchmarkItem to response

Getting Started

REST APIs

Resources

Developer Home