Get comment from UW task

API Method: GET /api/v1/uwTasks/ticket/getCommentsByTicketId

Description:

This API endpoint is used to retrieve comments associated with a specific Underwriting (UW) task ticket. Underwriting tasks often involve ongoing communication between the merchant, underwriting team, and administrators. This method allows users to view all comments or notes that have been added to a particular UW task, providing context or updates on the status and progress of the task.

Request:

• HTTP Method: GET
• Endpoint: /api/v1/uwTasks/ticket/getCommentsByTicketId
• Content-Type: application/json

Request Parameters:

The following parameters must be provided in the request:

• ID (required):
  The unique identifier of the merchant whose UW task comments are being retrieved.

  • Type: int32
  • Example: ID=12345

• ticketId (required):
  The identifier of the specific underwriting task (ticket) for which the comments are being requested.

  • Type: int32
  • Example: ticketId=67890

Response:

• Status Code:

  • 200 OK: If the comments are successfully retrieved.
  • 400 Bad Request: If the ID or ticketId is missing or invalid.
  • 500 Internal Server Error: If there is an issue processing the request.

• Response Body:
  The response includes a list of comments associated with the specified underwriting task ticket. Each comment includes the content of the comment, who added it, and the timestamp.

Example Request:

GET /api/v1/uwTasks/ticket/getCommentsByTicketId?ID=12345&ticketId=67890

Example Response:

{
  "comments": [
    {
      "commentId": 1,
      "text": "Please review the attached bank statements.",
      "author": "John Doe",
      "timestamp": "2024-10-01T15:23:45Z"
    },
    {
      "commentId": 2,
      "text": "Bank statements received. Under review.",
      "author": "Underwriting Team",
      "timestamp": "2024-10-02T09:10:20Z"
    }
  ]
}

Use Case:

This API method is used by ISO/ISV, administrators, or underwriting teams to retrieve all comments associated with a specific UW task. It helps users track communications, updates, or notes left by various parties, ensuring transparency and smooth handling of the underwriting process.