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

Get Account Permissions

Description

This request returns the permission setups on the account.

Request URL

Syntax GET /restapi/accounts/{accountnumber}/permissions
Example URL https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/permissions

Response Data Fields

Field Description
loginId

A unique ID for the member who is going to be granted permission on the account.

accountNumber

A unique ID for the account on which the permission will be granted.

permission

The level of the permission the member will be granted on the account.

alertLevel

The level of the alert communication the member will have on the account.

listOnReport

The indicator of whether the member will be listed on the different reports.

Response Example


HTTP/1.1 200 OK
Content-Type: application/json
[
  {
    "accountNumber":"RA1234ABCD",
    "alertLevel":"all",
    "listOnReport":true,
    "loginId":"advisorid1",
    "permission":"AC"
  },
  {
    "accountNumber":"RA1234ABCD",
    "alertLevel":"none",
    "listOnReport":false,
    "loginId":"testclient1",
    "permission":"MM"
  },
  {
    "accountNumber":"RA1234ABCD",
    "alertLevel":"limited",
    "listOnReport":false,
    "loginId":"advisorid2",
    "permission":"DV"
  },
  {
    "accountNumber":"RA1234ABCD",
    "alertLevel":"all",
    "listOnReport":false,
    "loginId":"testclient2",
    "permission":"DV"
  },
  {
    "accountNumber":"RA1234ABCD",
    "alertLevel":"all",
    "listOnReport":false,
    "loginId":"testclient3",
    "permission":"DV"
  }
]


Change Log

10/08/2015

  1. New documentation.

Getting Started

REST APIs

Resources

Developer Home