Page tree
Skip to end of metadata
Go to start of metadata

Retrieve list of grantee groups requestor has access to

URL /grantee-groups/{grantorGroupId}
HTTP Method GET
Version 1.0.6
Content

Request

Parameters

Parameter Name Location Type Multi-ple Values Usage Description
grantorGroupId Grantor Group ID Path String No REQUIRED

Group identifier (firm short name)

Response - 200

Body

Grantee Group Message - GranteeGroupMessage

Field Name Type Values Usage Description
count Count Integer

ALWAYS

Number of grantee groups returned

groups[] Groups GranteeGroupInfo

Grantee Group Info - GranteeGroupMessage.groups[]

Field Name Type Values Usage Description
granteeGroupId Grantee Group ID String

ALWAYS

Group ID identifier

granteeGroupName Grantee Group Name String

ALWAYS

Grantee group identifier (grantee group)

grantorGroupId Grantor Group ID String

ALWAYS

Unique identifier of the grantor group

members[] Members MemberInfo

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

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

type Limit Type String
  • BL
  • PM
OPTIONAL

Type of participant - a grantee group can be either prime ( PM) or bilateral ( BL)

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
  • 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
errors[] Errors Error

Error - ErrorMessage.errors[]

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

  • No labels