Comments

API Endpoints to access Comments

Get Project Comments

• Endpoint: GET /projects/{project_id}/comments

• Description: Retrieves comments for a specific project with pagination.

• Path Parameters:

  • project_id (integer, required): The unique identifier of the project.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of comments per page.

• Response: 200 OK Returns a JSON array containing comment objects.

Get Work Order Comments

• Endpoint: GET /work-orders/{work_order_id}/comments

• Description: Retrieves comments for a specific work order with pagination.

• Path Parameters:

  • work_order_id (integer, required): The unique identifier of the work order.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of comments per page.

• Response: 200 OK Returns a JSON array containing comment objects.

Get Client Comments

• Endpoint: GET /clients/{client_id}/comments

• Description: Retrieves comments for a specific client with pagination.

• Path Parameters:

  • client_id (integer, required): The unique identifier of the work order.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of comments per page.

• Response: 200 OK Returns a JSON array containing comment objects.

Get Request Comments

• Endpoint: GET /requests/{request_id}/comments

• Description: Retrieves comments for a specific request with pagination.

• Path Parameters:

  • request_id (integer, required): The unique identifier of the work order.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of comments per page.

• Response: 200 OK Returns a JSON array containing comment objects.