ChangeInPortSubscription

Overview

Method: POST
Endpoint: /api/ChangeInPortSubscription
Description: Modifies an existing in-port subscription request. This endpoint allows updates to donor details, porting wish dates, and other relevant parameters.

POST /api/ChangeInPortSubscription
Content-Type: application/json
{
  "activationId": "x3#####2dFV###fLl",
  "donorCustomerNumber": "DON67890",
  "portingWishDate": "2025-02-15T10:00:00+01:00"
}

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.
donorCustomerNumber (string, optional): Customer number of the donor provider.
portingWishDate (string, optional): Desired date for porting (ISO 8601 format).

Info

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

Response Structure

The response will include details about the modified subscription request:

{
    "id": "string",
    "createdAt": "2025-02-14T09:45:00+01:00",
    "modifiedAt": "2025-02-14T10:15:00+01:00",
    "status": "string",
    "activationType": "INPORT",
    "providerEnvironment": "SP16001",
    "referenceNumber": "string",
    "subscriptionId": "string",
    "phoneNumber": "string",
    "activatedDate": "2025-02-15T10:15:00+01:00",
    "info": {}
}

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.

Usage Notes

The activationId must correspond to an existing activation request.
The donorCustomerNumber to modify the out-porting party.
Use portingWishDate to modify the scheduled porting date.
The response includes a unique id to track the status of the modification.

Example Requests

Modify a porting request with a new activation date

POST /api/ChangeInPortSubscription
Content-Type: application/json

{
  "activationId": "ACT12345",
  "portingWishDate": "2025-02-15T10:00:00+01:00"
}

Modify a porting request without changing the activation date

POST /api/ChangeInPortSubscription
Content-Type: application/json
{
  "activationId": "ACT54321",
  "donorCustomerNumber": "DON09876"
}

Summary

The /api/ChangeInPortSubscription endpoint allows for modifying in-progress number porting requests.

Requires activationId and donorCustomerNumber.
Allows updating the scheduled porting date via portingWishDate.
Returns a tracking id to monitor the status of the modification via QueryActivation.

Use this API to make changes to active number porting requests efficiently.