CancelInPortSubscription

Overview

Method: POST
Endpoint: /api/CancelInPortSubscription
Description: Cancels an in-port subscription request. This endpoint allows terminating an ongoing porting request and optionally providing a reason for the cancellation.

POST /api/CancelInPortSubscription
Content-Type: application/json
{
  "activationId": "###T3mhh###UBxCSZ",
  "note": "Reason cancellation is that the services were not set yet."
}

Request Body Parameters

The request body should be a JSON object with the following structure:

activationId (string, required): The unique identifier for the activation request to cancel.
note (string, optional, max 164 characters): A reason or additional information for the cancellation.

Info

The activationId was provided in the response of the InPortSubscription request.

As long as the InportSubscription record has the the portingstatus = 'INIT' your CancelInport request will be rejected!

Response Structure

The response returns an Activation object with details of the cancellation:

{
    "id": "###T3mhh###UBxCSZ",
    "createdAt": "2025-02-06T12:26:41.905+01:00",
    "modifiedAt": "2025-02-06T13:11:43.7473966+01:00",
    "status": "BUSY",
    "activationType": "INPORT",
    "providerEnvironment": "SP16001",
    "referenceNumber": "",
    "subscriptionId": "###kh6QS###pWisPr",
    "phoneNumber": "06-######830",
    "info": {
        "isdn": "06-######830",
        "eSim": true,
        "subscriptionType": "VOICEDATA",
        "accessType": "INTERNETACCESS",
        "portingStatus": "CANCELLING",
        "email": "###@###.nl",
        "confirmationCode": "##########",
        "stnCustomerId": "###Sc3iA###MQCmA89",
        "portingWishDate": "2025-02-20T01:00:00+01:00",
        "donorCustomerNumber": "######",
        "note": "Inport request naar ###",
        "firstPossibleDate": "2025-02-06T09:30:00+01:00",
        "approvedDate": "2025-02-20T01:00:00+01:00"
    }
}

Field Descriptions

The fields in the response are the same as described in the InportSubscription message. Only the following will have been updated.

`Activation` Object

modifiedAt: The timestamp when the request was last modified.
status: The current status of the cancellation request:
- BUSY: The request is being processed.
- DONE: The cancellation was successfully completed.

`info` Object

portingStatus: 'CANCELLING' means the InportSubscription is being cancelled and is waiting for a aknowledment of the Out-porting provider.
note: The note you sent during the Cancellation

Info

Optional fields will only be included in the response if they were provided in the request.

Usage Notes

The activationId must match an existing activation request.
The note parameter is optional but recommended for internal tracking.
Store the response id to track the cancellation request.

Example Requests

Cancel a porting request with a reason

POST /api/CancelInPortSubscription
Content-Type: application/json
{
  "activationId": "###T3mhh###UBxCSZ",
  "note": "Reason cancellation is that the services were not set yet."
}

Cancel a porting request without a note

POST /api/CancelInPortSubscription
Content-Type: application/json
{
  "activationId": "###T3mhh###UBxCSZ"
}

Query the Activation

You will have to use the QueryActivation API every now and then to check the progress of the Cancellation process.

The response will look like:

{
    "offset": 0,
    "total": 86,
    "results": [
        {
            "id": "###T3mhh###UBxCSZ",
            "createdAt": "2025-02-06T12:26:41.905+01:00",
            "modifiedAt": "2025-02-06T13:11:48.218+01:00",
            "status": "BUSY",
            "activationType": "INPORT",
            "providerEnvironment": "SP16001",
            "referenceNumber": "",
            "providerOrderNumber": "03####0/2##5",
            "subscriptionId": "###kh6QS###pWisPr",
            "phoneNumber": "06-######830",
            "info": {
                "isdn": "06-######830",
                "eSim": true,
                "subscriptionType": "VOICEDATA",
                "accessType": "INTERNETACCESS",
                "portingStatus": "CANCELLING",
                "email": "###@###.nl",
                "confirmationCode": "##########",
                "stnCustomerId": "###Sc3iA###MQCmA89",
                "portingWishDate": "2025-02-20T01:00:00+01:00",
                "donorCustomerNumber": "######",
                "note": "Reason cancellation is that the ### were not set yet.",
                "firstPossibleDate": "2025-02-06T09:30:00+01:00",
                "approvedDate": "2025-02-20T01:00:00+01:00"
            }
        }
    ],
    "meta": {}
}

Field Descriptions

The fields in the response are the same as described in the orignal Activation record. Only the following will have been updated.

`Activation` Object

modifiedAt: The timestamp of the last modification to the activation request.
status: The current activation status:
- BUSY: The activation is being processed.
- DONE: The activation has been completed successfully.
info: Additional metadata related to the activation request.

`info` Object

portingStatus: 'CANCELLING' means the InportSubscription is being cancelled and is waiting for a aknowledment of the Out-porting provider.
note: The note you sent during the Cancellation

Note

The process will be finished when the status in the 'Activation' record is 'CANCELLED'. The portingStatus in the info object will be 'CANCELLED' as well then.

Summary

The /api/CancelInPortSubscription endpoint allows you to cancel an active number porting request.

Requires activationId to identify the request.
Optionally includes a note for tracking purposes.
Returns a tracking id to monitor the cancellation status via QueryActivation.

Use this API to efficiently manage and track porting cancellations.