Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get All Restrictions
This request returns a summary of account restrictions currently applied to a brokerage account.
Request URL
Syntax | GET /restapi/accounts/{accountnumber}/restrictions |
---|---|
Example URL | https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/restrictions |
Response Data Fields
Field | Description |
---|---|
accountNumber | Account identifier. |
accountRestrictionId | The indentifier of the restriction. |
creationTs | The restriction creation timestamp. |
inceptionInfo | Miscellaneous information provided by customer service. |
reason | See detail in Get a Restriction endpoint document. |
type | See detail in Get a Restriction endpoint document. |
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/accounts/RA1234ABCD/restrictions
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
[
{
"accountNumber" : "123123123123123",
"accountRestrictionId" : "6666666666666666666666",
"creationTs" : "2014-07-05T09:01:13.346-04:00",
"inceptionInfo" : " ",
"reason" : {
"code" : "022",
"comments" : "API Firm has not had their client approve.",
"name" : "API Account Approval"
},
"type" : {
"code" : "CR",
"description" : "Account is completely restricted",
"title" : "Complete Restriction"
}
},
{
"accountNumber" : "123123123123123",
"accountRestrictionId" : "77777777777777777777",
"creationTs" : "2014-07-05T09:14:55.790-04:00",
"inceptionInfo" : " ",
"reason" : {
"code" : "021",
"comments" : "Externally Set Restriction used through the API",
"name" : "External"
},
"type" : {
"code" : "CR",
"description" : "Account is completely restricted",
"title" : "Complete Restriction"
}
}
]