Get business documents

GET /api/v1/BusinessesDocuments/get-all

Description

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

Request

Path

/api/v{version}/BusinessesDocuments/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.

• Type: (string) Filter by document type.

• BusinessId: (string, format: uuid) Filter by Business ID.

• 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/BusinessesDocuments/get-all?SearchText=<string>&Decending=<boolean>&OrderBy=4&Type=14&BusinessId=<uuid>&PageNumber=<integer>&PageSize=<integer>

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
SearchText	<string>
Decending	<boolean>
OrderBy	4
Type	14
BusinessId	<uuid>
PageNumber	<integer>
PageSize	<integer>

Response: 200

{
  "pageNumber": `<integer>`,
  "pageSize": `<integer>`,
  "total": `<integer>`,
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": [
    {
      "id": `<uuid>`,
      "businessId": `<uuid>`,
      "type": 13,
      "path": `<string>`,
      "fileName": `<string>`,
      "documentNumber": `<string>`,
      "approved": `<boolean>`
    },
    {
      "id": `<uuid>`,
      "businessId": `<uuid>`,
      "type": 6,
      "path": `<string>`,
      "fileName": `<string>`,
      "documentNumber": `<string>`,
      "approved": `<boolean>`
    }
  ]
}