Get list of person document

GET /api/v1/PersonDocuments/get-all

Description

This endpoint is used to retrieve a list of person documents. It allows for searching, sorting, and pagination of the results.

Tags:

PersonDocuments

URL:

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

ApiKey:

No API key required

Content-Type:

application/json

Query Parameters:

• SearchText (string, nullable): Text to search for within the document.

• Decending (boolean, nullable): Determines if the results should be in descending order.

• OrderBy (enum, nullable): The property to order the results by (e.g., "Name", "Type", "CreatedDate").

• Type (enum, nullable): The type of document to filter by (e.g., "PDF", "DOCX", "JPG").

• PersonId (string, required): The ID of the person whose documents to retrieve.

• PageNumber (integer, format: int32): The page number to retrieve.

• PageSize (integer, format: int32): The number of items to return per page.

Path Parameters:

• version (string, required): The API version.

Request Body:

None

Response:

Success, returns a list of person documents with pagination information.

Error Codes:

None

Example:

/api/v1/PersonDocuments/get-all?SearchText=<string>&Decending=<boolean>&OrderBy=4&Type=14&PersonId=<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
PersonId	<uuid>
PageNumber	<integer>
PageSize	<integer>

Response: 200

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