SoftLayer Ticket::addFinalComments
From SoftLayer Development Network Wiki
addFinalComments is a member of the SoftLayer_Ticket service.
Contents |
Overview
As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate their overall experience with SoftLayer after a ticket is closed. addFinalComments() sets these comments for a ticket update made by a SoftLayer employee. Final comments may only be set on closed tickets, can only be set once, and may not exceed 4000 characters in length. Once the comments are set addFinalComments() returns a boolean true.
User Access
Users wishing to execute addFinalComments service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.
Return Type
addFinalComments returns the boolean data type.
Headers
Required Headers
addFinalComments requires the following headers:
Parameters
addFinalComments takes the following parameters:
finalComments
Feedback to leave on a closed ticket.
- Type: string
Error Handling
addFinalComments throws the following exceptions:
- SoftLayer_Exception_Public
- Throw the exception "You can only add final comments to a closed ticket." if the given ticket is not closed.
- SoftLayer_Exception_Public
- Throw the exception "This ticket already has final comments set." if the given ticket already has final comments set.
- SoftLayer_Exception_Public
- Throw the exception "Please provide final comments." if no final comments were passed to addFinalComments().
- SoftLayer_Exception_Public
- Throw the exception "Your final comments may not exceed 4000 characters in length." if the given final comments exceed 4000 characters in length.
- SoftLayer_Exception_Public
- Throw the exception "Unable to add final comments to this ticket." if the API was unable to add final comments to the given ticket.
