EBS Risk Management API - List Grantor Groups

Retrieve list of grantor groups requestor has access to

URL

/grantor-groups

HTTP Method

GET

Version

1.0.6

Content

Response - 200

Body

GrantorGroupMessage - GrantorGroupMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

count

Count

Integer

 

ALWAYS

 

groups[]

Groups

GrantorGroupInfo

 

Grantor Group Info - GrantorGroupMessage.groups[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

grantorGroupId

Grantor Group ID

String

 

OPTIONAL

 

grantorGroupName

Grantor Group Name

String

 

OPTIONAL

 

institution

Institution ID

String

 

OPTIONAL

 

institutionName

Institution Name

String

 

OPTIONAL

 

type

Type

String

 

OPTIONAL

 

members[]

Members

MemberInfo

 

Member Info - GrantorGroupMessage.groups[].members[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

description

Description

String

 

OPTIONAL

List of firms that are members of the group (firm short name), description

id

ID

String

 

OPTIONAL

Unique identifier of the grantor

Response - 400

Body

Error Message - ErrorMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error

 

Error - ErrorMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String

  • 400

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

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error

 

Error - ErrorMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Code

String

  • 403

ALWAYS

 

message

Message

String

 

ALWAYS

 

referenceIndex

Reference Index

Integer

 

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.