API : Porting Cancel

Introduction

This request will cancel a porting. The porting moves to stage IN_CANCELLED, and the subscribers in notify get an e-mail about it.

SIP: an ordered porting (IN_ORDERED, IN_CONFIRMED or IN_DONOR_CONTACTED) is first cancelled at ICH. If ICH fails, an error is returned and nothing is cancelled. Then the numbers of the porting are removed from their SIP accounts and from Telecom X.
MVNO: the MVNO account is deleted at the mobile network provider, because an MVNO account cannot exist without its number.

A porting that is completed (IN_COMPLETED) or already cancelled (IN_CANCELLED) cannot be cancelled.

The customer is charged a porting error fee when the porting was at stage IN_ORDERED or IN_CONFIRMED. An MVNO porting at stage IN_REJECTED is also charged.

Request

URL	https://api.telecomx.dk/porting/PORTING_ID/cancel
Method	GET
Access level	OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. RESELLER_ADMIN, ADMIN.
Param	PORTING_ID	Id of the porting (24 hex-char string)

Query example

https://api.telecomx.dk/porting/1234567890ABCDEF12345678/cancel

Response

Json object
success	Boolean	True if request was sucessful.

Example

{
  success: true
}

Errors

Error code	Message	Description
400	bad_request	Porting id not found in requested URI
404	not_found	Porting not found
403	access_denied	Porting is not at the right stage to be cancelled - it is completed or already cancelled, or ICH says the porting is too far along to be cancelled
403	access_denied	Insufficient access level
404	voiceAccount	The voice account the MVNO porting belongs to was not found - unable to determine mobile network provider
500	internal_error	ICH says number is invalid
500	internal_error	<Unspecified> - also when ICH fails in another way, or when the MVNO account cannot be deleted at the provider

WIKI

Table of Contents