Get all business beneficial

GET /api/v1/BusinessesBeneficials/get-all

Description

This endpoint allows the retrieval of details of all business beneficials.

Request

• Path

/api/v{version}/BusinessesBeneficials/get-all

Headers

• Accept-Language: Change default response message language from English(en). Available languages fr,en

Query Parameters

• SearchText: (string, nullable) Search text to filter the results.
• OrderBy: (string) Order by field.
• Decending: (boolean, nullable) Sort the results in descending order.
• PersonId: (string, format: uuid, nullable) Filter by Person ID.
• BusinessId: (string, format: uuid, nullable) Filter by Business ID.
• IsSignee: (boolean, nullable) Filter by signee status.
• BusinessRelationship: (string) Filter by relationship to business.
• PageNumber: (integer, format: int32) Page number for pagination.
• PageSize: (integer, format: int32) Number of records per page.
• version: API version.

Response

• Success (200)

/api/v1/BusinessesBeneficials/get-all?SearchText=<string>&OrderBy=2&Decending=<boolean>&PersonId=<uuid>&BusinessId=<uuid>&IsSignee=<boolean>&BusinessRelationship=3&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
SearchText	<string>
OrderBy	2
Decending	<boolean>
PersonId	<uuid>
BusinessId	<uuid>
IsSignee	<boolean>
BusinessRelationship	3
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "id": `<uuid>`,
      "isSignee": `<boolean>`,
      "personId": `<uuid>`,
      "businessId": `<uuid>`,
      "votingShare": `<float>`,
      "relationshipToBusiness": 1
    },
    {
      "id": `<uuid>`,
      "isSignee": `<boolean>`,
      "personId": `<uuid>`,
      "businessId": `<uuid>`,
      "votingShare": `<float>`,
      "relationshipToBusiness": 1
    }
  ]
}