addFinalComments


SoftLayer_Ticket::addFinalComments

Add final comments to a closed ticket.

Description

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.

Parameters

Name Type Description
finalComments string Feedback to leave on a closed ticket.

Required Headers

Optional Headers

  • None

Return Values

  • boolean

Error Handling

  • Throw the exception “You can only add final comments to a closed ticket.” if the given ticket is not closed.
  • Throw the exception “This ticket already has final comments set.” if the given ticket already has final comments set.
  • Throw the exception “Please provide final comments.” if no final comments were passed to ‘‘addFinalComments()’’.
  • Throw the exception “Your final comments may not exceed 4000 characters in length.” if the given final comments exceed 4000 characters in length.
  • Throw the exception “Unable to add final comments to this ticket.” if the API was unable to add final comments to the given ticket.

Associated Methods

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Ticket/{SoftLayer_TicketID}/addFinalComments'