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.