Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
granteeGroupId | Grantee Group ID | Path | String | No | REQUIRED | Group identifier (firm short name) |
Response - 200
Body
GranteeGroupLimits - GranteeGroupLimits
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
count | Count | Integer | ALWAYS | Number of grantee groups returned | |
grantorGroupId | Grantor Group ID | String | ALWAYS | Unique identifier of the grantor group | |
limits[]
| Limits | Limit |
Limit - GranteeGroupLimits.limits[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
currentLimit | Current Limit | Integer | ALWAYS | Current limit being enforced | |
dav | Daily Adjusted Value | Integer | ALWAYS | Daily adjusted value | |
defaultLimit | Current Limit | Integer | ALWAYS | Limit that will be enforced next day | |
type | Limit Type | String |
| ALWAYS | The type of limit |
Response - 400
Body
Error Message - ErrorMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
errors[]
| Errors | Error |
Error - ErrorMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
code | Code | String |
| ALWAYS | |
message | Message | String | ALWAYS | ||
referenceIndex | Reference Index | Integer | ALWAYS |
Bad Request
Response - 401
Unauthorized
Response - 403
Body
Error Message - ErrorMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
errors[]
| Errors | Error |
Error - ErrorMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
code | Code | String |
| ALWAYS | |
message | Message | String | ALWAYS | ||
referenceIndex | Reference Index | Integer | ALWAYS |
Forbidden
Response - 404
Not Found
Response - 500
Internal Server Error