SoftLayer Ticket::createCancelServerTicket

From SoftLayer Development Network Wiki

Jump to: navigation, search

createCancelServerTicket is a member of the SoftLayer_Ticket service.

Contents

Overview

A cancel server request creates a sales ticket. The hardware ID parameter is required to determine which server is to be cancelled.

The reason parameter could be from the list below:

  • "No longer needed"
  • "Business closing down"
  • "Server / Upgrade Costs"
  • "Migrating to larger server"
  • "Migrating to smaller server"
  • "Migrating to a different SoftLayer datacenter"
  • "Network performance / latency"
  • "Support response / timing"
  • "Sales process / upgrades"
  • "Moving to competitor"


The content parameter describes further the reason for cancelling the server.

User Access

Users wishing to execute createCancelServerTicket service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.

Return Type

createCancelServerTicket returns the SoftLayer_Ticket data type.

Headers

Required Headers

createCancelServerTicket requires the following headers:

Parameters

createCancelServerTicket takes the following parameters:

hardwareId

Hardware ID of server to cancel server.

  • Type: integer


reason

Cancellation reason.

  • Type: string


content

Cancellation content for ticket. A brief description explaining the cancellation reason.

  • Type: string

Error Handling

createCancelServerTicket throws the following exceptions:

  • SoftLayer_Exception
Throws the exception "Hardware ID must be provided." when hardware id parameter is not provided.
  • SoftLayer_Exception
Throws the exception "Cancellation reason must be provided." when reason parameter is not provided.
  • SoftLayer_Exception
Throws the exception "Cancellation content description must be provided." when content parameter is not provided.
  • SoftLayer_Exception
Throws the exception "You do not have permission to this service." when a portal user does not have permission to cancel server.
Retrieved from "http://sldn.softlayer.com/wiki/index.php/SoftLayer_Ticket::createCancelServerTicket"
Personal tools