EBS Risk Management API - List Grantee Groups
Retrieve list of grantee groups requestor has access to
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.6 |
Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
| Grantor Group ID | Path |
| No |
| REQUIRED | Group identifier (firm short name) |
Response - 200
Body
Grantee Group Message -
GranteeGroupMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Count |
|
| ALWAYS | Number of grantee groups returned |
Groups |
|
|
Grantee Group Info -
GranteeGroupMessage.groups[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Grantee Group ID |
|
| ALWAYS | Group ID identifier |
| Grantee Group Name |
|
| ALWAYS | Grantee group identifier (grantee group) |
| Grantor Group ID |
|
| ALWAYS | Unique identifier of the grantor group |
Members |
|
|
Member Info -
GranteeGroupMessage.groups[].members[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Description |
|
| OPTIONAL | List of firms that are members of the group (firm short name), description |
| ID |
|
| OPTIONAL | Unique identifier of the grantor |
| Limit Type |
|
| OPTIONAL | Type of participant - a grantee group can be either prime (
|
Response - 400
Body
Error Message -
ErrorMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
|
|
Error -
ErrorMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Code |
|
| ALWAYS |
|
| Message |
|
| ALWAYS |
|
| Reference Index |
|
| ALWAYS |
|
Bad Request
Response - 401
Unauthorized
Response - 403
Body
Error Message -
ErrorMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
|
|
Error -
ErrorMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Code |
|
| ALWAYS |
|
| Message |
|
| ALWAYS |
|
| Reference Index |
|
| ALWAYS |
|
Forbidden
Response - 404
Not Found
Response - 500
Internal Server Error
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.