SPS - Port-In Management
Documentation Powered by Redocly

SPS - Port-In Management (v5)

Download OpenAPI specification:Download

The "Port-In Management" API provides the ability to facilitate Port-In management operations.

Operations

Provides the ability to perform port-in eligibility check for the given GPSI

This API provides the ability to perform port-in eligibility check for the given GPSI to ensure it may be ported in to Dish's network.

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This represents request model of port-In Eligibility.

gpsi
required
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

Responses

Request samples

Content type
application/json
{
  • "gpsi": "19459986891"
}

Response samples

Content type
application/json
Example
PortIn Eligibility Reject
PortIn Eligibility Reject
PortIn Eligibility Eligible
{
  • "eligibilityStatus": "Reject",
  • "checkedDate": "2021-02-04T10:00:00Z",
  • "reasonCode": "8A",
  • "reasonDesc": "NumberalreadyActive"
}

Provides the ability to submit new subscription activation request with port-in GPSI

This API provides the capability to activate subscription with set of products, services for a given subscriber by wholesale customer and instantiate buckets/allowances
Prerequisites:

  1. Check Network Coverage for the given address/location
  2. Check Device compatibility with network
  3. Check SIM availability
  4. Check PortIn Eligibility


Note:
  1. wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand
  2. address in request represents registered address of subscription with loosing operator
  3. activationAddress in request represents address on which subscriber wants to activate subscription
  4. When activation address and port addresses are same, address alone is required
  5. When activation address and port addresses are different, address and portAddress are required
  6. When portIN activation with BYOD is triggered, eid is required in request payload
header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This is the model of Create Port-In request.

partnerTransactionId
required
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$

Transaction identifier/order identifier of Wholesale API consumer/partner

subscriberId
required
string (SubscriberId) [ 1 .. 36 ] characters ^[-a-zA-Z0-9\s].*$

Unique Subscriber Identifier

wholesalePlanId
required
string [ 1 .. 36 ] characters ^[-a-zA-Z0-9\s].*$

Wholesale Plan Identifier

bucketRefId
Array of strings[ items non-empty ]
eSIMDeliveryMethod
string
Value: "QR"

eSIM Delivery Method and possible values are QR

billCycleFrequency
string
Default: "MONTHLY"
Value: "MONTHLY"

Bill Cycle Frequency for the subscription

billCycleStartDay
number [ 1 .. 28 ]

Bill Start Day or Offset Day. If billCycleStartDay is not included in payload, then API will default as below

  • If day of system date is in between 1 and 28, then API will consider day of system date
  • else, then API will consider 1 (1st day of month)

gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

iccid
string [ 19 .. 20 ] characters ^[0-9]{19,20}$

ICCID

pei
string [ 15 .. 17 ] characters ^[0-9]{15,17}$

PEI or IMEI

eid
string [ 19 .. 32 ] characters ^[0-9]{19,32}$

EID of ESIM

Array of objects (Product) [ items ]

Products to be add/remove/update on top of wholesale plan benefits

required
object

Port-In Information

Responses

Request samples

Content type
application/json
Example
Create PortIn Request with same activation address and port address
Create PortIn Request with same activation address and port address
Create PortIn Request with different activation address and port address
Create PortIn Request with same activation address and port address with BYOD
Create PortIn Request with different activation address and port address with BYOD
{
  • "partnerTransactionId": "WhlSlOrd12345",
  • "subscriberId": "SUB3742259805",
  • "wholesalePlanId": "WhlCus070522",
  • "bucketRefId": [
    ],
  • "eSIMDeliveryMethod": "QR",
  • "billCycleFrequency": "MONTHLY",
  • "billCycleStartDay": 1,
  • "gpsi": "19459986891",
  • "iccid": "11986621644523024501",
  • "pei": "2288151828896431",
  • "products": [
    ],
  • "portInfo": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Provides the ability to update the port-in request using partnerTransactionId of createPortIn Request if port status is rejected or resolution required

This method provides the ability to update port-in request using partnerTransactionId of createPortIn Request incase port request status is rejected or resolution required. It is recommended to verify the PortInActivationEvent or query port-in details prior to submission of updatePortIn request

Note:

  1. wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand
  2. On updatePortInRequest, portAddress can only updated if there is any port conflict with address. Update on activationAddress is not allowed

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This is the model of Update Port-In Request.

partnerTransactionId
required
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$

Transaction identifier/order identifier of Wholesale API consumer/partner

gpsi
required
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

required
object

The below port-in Info can be updated based on port-in failures

  • authorizationName
  • accountNo
  • pwdPin
  • termsCondition
  • contact
  • location

Responses

Request samples

Content type
application/json
{
  • "partnerTransactionId": "WhlSlOrd12345",
  • "gpsi": "19459986891",
  • "updatePortInfo": {
    }
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Provides the ability to cancel the port-in request using partnerTransactionId of createPortIn Request if port status is rejected or resolution required

This method provides the ability to cancel port-in request using partnerTransactionId of createPortIn Request incase port request status is rejected or resolution required. It is recommended to verify the PortInActivationEvent or query port-in details prior to submission of cancelPortIn request

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Request Body schema: application/json

This is the model of Cancel Port-In Request

partnerTransactionId
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$

Transaction identifier/order identifier of Wholesale API consumer/partner

gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$

GPSI/MSISDN to be ported-in

Responses

Request samples

Content type
application/json
Example
CancelPortIn Request by partner transaction Id
CancelPortIn Request by partner transaction Id
CancelPortIn Request by GPSI
{
  • "partnerTransactionId": "WhlSlOrd12345"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}

Provides the ability to query port-in request details based on GPSI or partnerTransactionId or portOrderId

This API provides the ability to query port-in request details based on GPSI or partnerTransactionId or portOrderId

Note: wholesaleCustomerId is an optional parameter that allows sub nodes of the customer hierarchy to be actioned upon, e.g. this can be used to specify a particular brand

query Parameters
gpsi
string (GPSI) [ 11 .. 15 ] characters ^[0-9]{11,15}$
Example: gpsi=19459986891

Port-In GPSI

partnerTransactionId
string (PartnerTransactionId) [ 1 .. 36 ] characters ^.*$
Example: partnerTransactionId=WhlSlOrd12345

Transaction identifier/order identifier of PortIn Request

portOrderId
string (PortOrderId) [ 1 .. 36 ] characters ^.*$
Example: portOrderId=490J821336jEuzZs

Port Order Id, which is generated by number portability application

header Parameters
X-Correlation-Id
string <uuid> (CorrelationId)
Example: TQA20210903155950999

Correlation Identifier denotes the process flow identifier. This is used for telemetry purposes

wholesaleCustomerId
string (CustomerId) ^.*$
Example: 100000108464

Identifier of wholesale customer/partner

Responses

Response samples

Content type
application/json
{
  • "gpsi": "19459986891",
  • "partnerTransactionId": "WhlSlOrd12345",
  • "portOrderId": "490J821336jEuzZs",
  • "portOrderVersion": "01",
  • "subscriberId": "SUB3742259805",
  • "portStatus": "OPEN",
  • "reasonCode": "8A",
  • "reasonDescription": "Account number required or incorrect",
  • "desiredDueDate": "2021-02-04T10:00:00Z",
  • "portDirection": "A",
  • "portLastUpdateDate": "2021-02-04T10:00:00Z",
  • "portOriginalSubmissionDate": "2021-02-04T10:00:00Z",
  • "portInfo": {
    },
  • "newNetworkServiceProvider": "490J",
  • "oldNetworkServiceProvider": "X720",
  • "oldLocalServiceProvider": "X720",
  • "newLocalServiceProvider": "490J"
}