Portability API
V1
Get info about portabilities
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
filter string (query) | Add filter to get portabilites |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [Portability] |
401 | Unauthorized | None |
500 | Internal Server Error | None |
200 - instance of Portability
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
access_type | string | false | none |
cause_status | string | false | none |
contract_code | string | false | none |
create_date_nc | string | false | none |
donor_operator | string | false | none |
external_reference | string | false | none |
icc_id | string | false | none |
id | string | false | none |
message_type | string | false | none |
msisdn | string | false | none |
nrn_receptor | string | false | none |
process_id | string | false | none |
recipient_operator | string | false | none |
recipient_rol | boolean | false | none |
state | string | false | none |
tenant | string | false | none |
window_date | string | false | none |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
processId*required string (path) | ProcessId |
filter string (query) | Add filter to get portabilites |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [Portability] |
401 | Unauthorized | None |
500 | Internal Server Error | None |
200 - instance of Portability
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
access_type | string | false | none |
cause_status | string | false | none |
contract_code | string | false | none |
create_date_nc | string | false | none |
donor_operator | string | false | none |
external_reference | string | false | none |
icc_id | string | false | none |
id | string | false | none |
message_type | string | false | none |
msisdn | string | false | none |
nrn_receptor | string | false | none |
process_id | string | false | none |
recipient_operator | string | false | none |
recipient_rol | boolean | false | none |
state | string | false | none |
tenant | string | false | none |
window_date | string | false | none |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
msisdn*required string (path) | Msisdn |
filter string (query) | Add filter to get portabilites |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [Portability] |
401 | Unauthorized | None |
500 | Internal Server Error | None |
200 - instance of Portability
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
access_type | string | false | none |
cause_status | string | false | none |
contract_code | string | false | none |
create_date_nc | string | false | none |
donor_operator | string | false | none |
external_reference | string | false | none |
icc_id | string | false | none |
id | string | false | none |
message_type | string | false | none |
msisdn | string | false | none |
nrn_receptor | string | false | none |
process_id | string | false | none |
recipient_operator | string | false | none |
recipient_rol | boolean | false | none |
state | string | false | none |
tenant | string | false | none |
window_date | string | false | none |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
msisdn*required string (path) | Msisdn |
filter string (query) | Add filter to get portabilites |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [Portability] |
401 | Unauthorized | None |
500 | Internal Server Error | None |
200 - instance of Portability
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
access_type | string | false | none |
cause_status | string | false | none |
contract_code | string | false | none |
create_date_nc | string | false | none |
donor_operator | string | false | none |
external_reference | string | false | none |
icc_id | string | false | none |
id | string | false | none |
message_type | string | false | none |
msisdn | string | false | none |
nrn_receptor | string | false | none |
process_id | string | false | none |
recipient_operator | string | false | none |
recipient_rol | boolean | false | none |
state | string | false | none |
tenant | string | false | none |
window_date | string | false | none |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
id*required string (path) | id |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | PortabilityDetail |
401 | Unauthorized | None |
500 | Internal Server Error | None |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | Portability |
401 | Unauthorized | None |
500 | Internal Server Error | None |
Parameters
Name | Description |
---|---|
orgs*required string (path) | Tenant |
operator string (query) | Operator |
operatorCode string (query) | Operator code |
status string (query) | Operator status |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [OperatorConfigs] |
404 | Not Found | None |
500 | Internal Server Error | None |
200 - instance of OperatorConfigs
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | [OperatorConfig] | false | none |
Endpoints
Mobile portabilities
- GET
/orgs/{orgs}/portabilities/orgs/{orgs}/portabilities
- GET
/orgs/{orgs}/portabilities/processId/{processId}/orgs/{orgs}/portabilities/processId/{processId}
- GET
/orgs/{orgs}/portabilities/msisdn/{msisdn}/orgs/{orgs}/portabilities/msisdn/{msisdn}
- GET
/orgs/{orgs}/portabilities/msisdn/{msisdn}/last/orgs/{orgs}/portabilities/msisdn/{msisdn}/last
- GET
/orgs/{orgs}/portabilities/id/{id}/orgs/{orgs}/portabilities/id/{id}
- GET
/orgs/{orgs}/portabilities/pendingDonor/orgs/{orgs}/portabilities/pendingDonor
- GET
/orgs/{orgs}/operator/orgs/{orgs}/operator
Mobile operations
- POST
/orgs/{orgs}/portabilities/orgs/{orgs}/portabilities
- POST
/orgs/{orgs}/portabilities/{processId}/accept/orgs/{orgs}/portabilities/{processId}/accept
- POST
/orgs/{orgs}/portabilities/{processId}/deny/orgs/{orgs}/portabilities/{processId}/deny
- GET
/orgs/{orgs}/ownerOperator/{msisdn}/orgs/{orgs}/ownerOperator/{msisdn}
- POST
/orgs/{orgs}/portabilities/{processId}/restartReply/orgs/{orgs}/portabilities/{processId}/restartReply
- POST
/orgs/{orgs}/portabilities/{msisdn}/cancel/orgs/{orgs}/portabilities/{msisdn}/cancel