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

Get Account Permission Details

Description

This request returns the detailed permission setups on the account.

Request URL

Syntax GET /restapi/accounts/{accountnumber}/roles?loginid={loginid}
Example URL https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/roles?loginid=testlogin

Response Data Fields

Field Description
accountNumber

account number

loginId

client member login id

accountAccessPermissions

A list of permissions the client has for the account.

Response Example 1: Get permissons with providing loginId



HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/account/RA1234ABCD/roles?loginid=userloginid
Link: ; rel="GET"; type="application/json""
Content-Type: application/json
Transfer-Encoding: chunked
Date: Nov, 11 Feb 2016 18:23:54 GMT

[
   {
      "accountAccessPermissions":[
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_HOLDINGS",
         "VIEW_ACCOUNT_PERFORMANCE",
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_STATISTICS",
         "VIEW_FOLIO_SUMMARY",
         "VIEW_FOLIO_HOLDINGS",
         "VIEW_FOLIO_PERFORMANCE",
         "VIEW_FOLIO_STATISTICS",
         "VIEW_ACCOUNT_ORDER_STATUS",
         "VIEW_TAX_INFORMATION",
         "VIEW_FOLIO_TRANSACTION_HISTORY",
         "VIEW_FOLIO_ORDER_STATUS",
         "VIEW_FOLIO_TAX_INFORMATION",
         "VIEW_PROFILE_PAGE",
         "DEPOSIT_AND_WITHDRAW_MONEY",
         "CREATE_MODIFY_AND_DELETE_EFT_BANKLINK",
         "SET_UP_CHECK_WRITING",
         "CREATE_MODIFY_AND_DELETE_AUTO_BUY_AND_SELL_INSTRUCTIONS",
         "ADD_NEW_SECURITIES_TO_A_FOLIO",
         "SELL_FOLIO_SECURITIES",
         "SELL_ALL_FOLIO_SECURITIES",
         "BUY_AND_SELL_SECURITY_THROUGH_DIRECT_TRADES",
         "MODIFY_AND_CANCEL_ORDERS",
         "CREATE_RENAME_AND_CLOSE_FOLIOS",
         "CHANGE_CASH_DISTRIBUTION_PREFERENCE",
         "VIEW_TRADE_CONFIRMATIONS",
         "GRANT_CHANGE_AND_DELETE_ACCESS",
         "VOTE_PROXY_STATEMENTS_AND_CORPORATE_ACTIONS",
         "VIEW_ACCOUNT_STATEMENTS",
         "VIEW_RESTRICTED_ACCOUNT_ALERTS",
         "VIEW_CORPORATE_ACTION_ALERTS",
         "VIEW_CHANGE_IRA_BENEFICIARY_ALERTS",
         "VIEW_ORDER_CANCELLATION_ALERTS",
         "VIEW_EFT_ALERTS",
         "CHANGE_PROFILE_PAGE",
         "MODIFY_ACCOUNT_SETTINGS",
         "VIEW_MESSAGE_CENTER",
         "VIEW_IFA"
      ],
      "accountNumber":"RE1986500F",
      "loginId":"folioapi1"
   }
]

Response Example 2: Get permissons WITHOUT providing loginId


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/account/RA1234ABCD/roles
Link: ; rel="GET"; type="application/json""
Content-Type: application/json
Transfer-Encoding: chunked
Date: Nov, 11 Feb 2016 18:23:54 GMT
[
   {
      "accountAccessPermissions":[
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_HOLDINGS",
         "VIEW_ACCOUNT_PERFORMANCE",
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_STATISTICS",
         "VIEW_FOLIO_SUMMARY",
         "VIEW_FOLIO_HOLDINGS",
         "VIEW_FOLIO_PERFORMANCE",
         "VIEW_FOLIO_STATISTICS",
         "VIEW_ACCOUNT_ORDER_STATUS",
         "VIEW_TAX_INFORMATION",
         "VIEW_FOLIO_TRANSACTION_HISTORY",
         "VIEW_FOLIO_ORDER_STATUS",
         "VIEW_FOLIO_TAX_INFORMATION",
         "VIEW_PROFILE_PAGE",
         "DEPOSIT_AND_WITHDRAW_MONEY",
         "CREATE_MODIFY_AND_DELETE_EFT_BANKLINK",
         "SET_UP_CHECK_WRITING",
         "CREATE_MODIFY_AND_DELETE_AUTO_BUY_AND_SELL_INSTRUCTIONS",
         "ADD_NEW_SECURITIES_TO_A_FOLIO",
         "SELL_FOLIO_SECURITIES",
         "SELL_ALL_FOLIO_SECURITIES",
         "BUY_AND_SELL_SECURITY_THROUGH_DIRECT_TRADES",
         "MODIFY_AND_CANCEL_ORDERS",
         "CREATE_RENAME_AND_CLOSE_FOLIOS",
         "CHANGE_CASH_DISTRIBUTION_PREFERENCE",
         "VIEW_TRADE_CONFIRMATIONS",
         "GRANT_CHANGE_AND_DELETE_ACCESS",
         "VOTE_PROXY_STATEMENTS_AND_CORPORATE_ACTIONS",
         "VIEW_ACCOUNT_STATEMENTS",
         "VIEW_RESTRICTED_ACCOUNT_ALERTS",
         "VIEW_CORPORATE_ACTION_ALERTS",
         "VIEW_CHANGE_IRA_BENEFICIARY_ALERTS",
         "VIEW_ORDER_CANCELLATION_ALERTS",
         "VIEW_EFT_ALERTS",
         "CHANGE_PROFILE_PAGE",
         "MODIFY_ACCOUNT_SETTINGS",
         "VIEW_MESSAGE_CENTER",
         "VIEW_IFA"
      ],
      "accountNumber":"RE1986500F",
      "loginId":"folioapi1"
   },
   {
      "accountAccessPermissions":[
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_HOLDINGS",
         "VIEW_ACCOUNT_PERFORMANCE",
         "VIEW_ACCOUNT_SUMMARY",
         "VIEW_ACCOUNT_STATISTICS",
         "VIEW_FOLIO_SUMMARY",
         "VIEW_FOLIO_HOLDINGS",
         "VIEW_FOLIO_PERFORMANCE",
         "VIEW_FOLIO_STATISTICS",
         "VIEW_ACCOUNT_ORDER_STATUS",
         "VIEW_TAX_INFORMATION",
         "VIEW_FOLIO_TRANSACTION_HISTORY",
         "VIEW_FOLIO_ORDER_STATUS",
         "VIEW_FOLIO_TAX_INFORMATION",
         "VIEW_PROFILE_PAGE",
         "VIEW_MESSAGE_CENTER",
         "VIEW_IFA"
      ],
      "accountNumber":"RE1986500F",
      "loginId":"axiunt5iym"
   }
]


Change Log

12/02/2016

  1. New documentation.

Getting Started

REST APIs

Resources

Developer Home