Counterparties Search

GET /api/v1/Counterparties/search

Description

This endpoint is used to search for counterparties based on the given search criteria.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

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

Path Parameters:

• version: string, required

Query Parameters:

• PageNumber: integer, optional

• PageSize: integer, optional

• searchText: string, optional

Request Body:

• None

URL:
{{baseUrl API url}}/api/v1/Counterparties/search

Response:

• A CounterpartyResponseListPagedResponse object containing the list of counterparties that match the search criteria.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/search?searchText=Company&PageNumber=1&PageSize=10
Content-Type: application/json

Response:

HTTP/1.1 200 OK
{
  "pageNumber": 1,
  "pageSize": 10,
  "totalPages": 2,
  "totalItems": 11,
  "counterparties": [
    {
      "id": "1234567890",
      "name": "Company X",
      "address": "123 Main St, City, State",
      "phoneNumber": "+1234567890",
      "email": "company@example.com"
    },
    {
      "id": "0987654321",
      "name": "Company Y",
      "address": "456 Elm St, City, State",
      "phoneNumber": "+0987654321",
      "email": "company@example.com"
    },
    ...
  ]
}

Method: GET

/api/v1/Counterparties/search?PageNumber=<integer>&PageSize=<integer>&searchText=<string>

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
PageNumber	<integer>
PageSize	<integer>
searchText	<string>

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "userId": "<uuid>",
      "name": "<string>",
      "email": "<string>",
      "address": "<string>",
      "lei": "<string>",
      "country": "<string>",
      "phoneCode": "<string>",
      "phoneNumber": "<string>",
      "state": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "merchantId": "<uuid>"
    },
    {
      "id": "<uuid>",
      "userId": "<uuid>",
      "name": "<string>",
      "email": "<string>",
      "address": "<string>",
      "lei": "<string>",
      "country": "<string>",
      "phoneCode": "<string>",
      "phoneNumber": "<string>",
      "state": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "merchantId": "<uuid>"
    }
  ]
}