Interface Request.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- Enclosing class:
- Request
@ApiService("SoftLayer_Billing_Item_Cancellation_Request") public static interface Request.Service extends Service
SoftLayer customers can use this API to submit a cancellation request. A single service cancellation can contain multiple cancellation items which contain a billing item.
-
Method Summary
Modifier and Type Method Description Request.ServiceAsync
asAsync()
Get an async version of this serviceRequest
createObject(Request templateObject)
This method creates a service cancellation request.Account
getAccount()
The SoftLayer account that a service cancellation request belongs to.List<Request>
getAllCancellationRequests()
This method returns all service cancellation requests.GregorianCalendar
getCancellationCutoffDate(Long accountId, String categoryCode)
Services can be canceled 2 or 3 days prior to your next bill date.List<Item>
getItems()
A collection of service cancellation items.Request
getObject()
getObject retrieves the SoftLayer_Billing_Item_Cancellation_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item_Cancellation_Request service.Status
getStatus()
The status of a service cancellation request.Ticket
getTicket()
The ticket that is associated with the service cancellation request.Customer
getUser()
The user that initiated a service cancellation request.Boolean
removeCancellationItem(Long itemId)
This method removes a cancellation item from a cancellation request that is in "Pending" or "Approved" status.Boolean
requestVoid(Boolean closeRelatedTicketFlag)
This method voids a service cancellation request in "Pending" or "Approved" status.void
setMask(Request.Mask mask)
Boolean
validateBillingItemForCancellation(Long billingItemId)
This method examined if a billing item is eligible for cancellation.Request.Mask
withMask()
Use the existing mask on this service or create it if not presentRequest.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Request.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Request.Mask withNewMask()Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Request.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
createObject
This method creates a service cancellation request.
You need to have "Cancel Services" privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the "items" property. Make sure billing item's category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product category]] service. -
getAllCancellationRequests
This method returns all service cancellation requests.
Make sure to include the "resultLimit" in the SOAP request header for quicker response. If there is no result limit header is passed, it will return the latest 25 results by default. -
getCancellationCutoffDate
Services can be canceled 2 or 3 days prior to your next bill date. This service returns the time by which a cancellation request submission is permitted in the current billing cycle. If the current time falls into the cut off date, this will return next earliest cancellation cut off date.
Available category codes are: service, server -
getObject
getObject retrieves the SoftLayer_Billing_Item_Cancellation_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item_Cancellation_Request service. You can only retrieve cancellation request records that are assigned to your SoftLayer account. -
removeCancellationItem
This method removes a cancellation item from a cancellation request that is in "Pending" or "Approved" status. -
validateBillingItemForCancellation
This method examined if a billing item is eligible for cancellation. It checks if the billing item you provided is already in your existing cancellation request. -
requestVoid
@ApiMethod(value="void", instanceRequired=true) Boolean requestVoid(Boolean closeRelatedTicketFlag)This method voids a service cancellation request in "Pending" or "Approved" status. -
getAccount
The SoftLayer account that a service cancellation request belongs to. -
getItems
A collection of service cancellation items. -
getStatus
The status of a service cancellation request. -
getTicket
The ticket that is associated with the service cancellation request. -
getUser
The user that initiated a service cancellation request.
-