Counterparty Group Members Search

GET /api/v1/Counterparties/groups/members/search

Description

This endpoint is used to search for counterparty group members based on the provided search criteria. It returns a CounterpartyGroupMemberListPagedResponse object containing information about the matching members.

Method:

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain
• application/json
• text/json

Path Parameters:

• version: string, required

Query Parameters:

• PageSize: integer, format: int32, optional, the number of items to include per page (default is 10)

• PageNumber: integer, format: int32, optional, the page number (default is 1)

• GroupId: string, format: uuid, optional, the id of the counterparty group to search within

• SearchText: string, nullable, optional, the text to search for within the group members' names

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/groups/members/search

Response:

• A CounterpartyGroupMemberListPagedResponse object containing information about the matching members.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups/members/search?GroupId=1234567890&SearchText=John&PageSize=5&PageNumber=1

Response:

HTTP/1.1 200 OK
{
  "totalItems": 3,
  "pageNumber": 1,
  "pageSize": 5,
  "items": [
    {
      "id": "1234567890",
      "name": "John Doe",
      "role": "Administrator"
    },
    {
      "id": "0987654321",
      "name": "John Smith",
      "role": "Member"
    },
    {
      "id": "9876543210",
      "name": "John Johnson",
      "role": "Member"
    }
  ]
}

Method: GET

/api/v1/Counterparties/groups/members/search?PageSize=<integer>&PageNumber=<integer>&GroupId=<uuid>&SearchText=<string>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PageSize	<integer>
PageNumber	<integer>
GroupId	<uuid>
SearchText	<string>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "counterpartyGroupId": "<uuid>"
    },
    {
      "id": "<uuid>",
      "counterpartyId": "<uuid>",
      "counterpartyName": "<string>",
      "counterpartyGroupId": "<uuid>"
    }
  ]
}