V2
Operations
Access to operations on the portabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filters | query | string | false | Typical filters: externalReference, recipientRol, messageType, processType, … |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | [portabilityInfo] |
| 400 | Bad Request | Invalid parameters supplied | None |
| 404 | Not Found | Portability not found | None |
| 405 | Method Not Allowed | Validation exception | None |
200 - instance of portabilityInfo
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneRanges | phoneRanges | false | none |
| stateId | stateId | false | portability state |
| messageType | messageType | false | Message type Portabaility |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
| recipientRol | recipientRol | true | operator rol recipient or donor |
| processId | processId | true | process id in Portanet |
| recipientOperator | recipientOperator | false | current recipient operator code |
| donorOperator | donorOperator | false | initial donor operator code |
| requestDate | requestDate | false | request date for portability |
| messageDate | messageDate | false | date to send to Portanet |
| windowDate | windowDate | false | portability window |
| cancellationDate | cancellationDate | false | cancellation date |
| processType | processType | false | process type |
| administrative | administrative | false | administrative access number |
| lluProcessId | lluProcessId | false | local loop unbundling identifier |
| fullNumberFlag | fullNumberFlag | false | full number flag |
| wholesalerFlag | wholesalerFlag | false | wholesaler flag |
| accessType | accessType | false | portability access type |
| donorResellerOperator | donorResellerOperator | false | donor reseller operator |
| recipientResellerOperator | recipientResellerOperator | false | recipient reseller operator |
| subscriber | subscriber | false | none |
| causeCode | causeCode | false | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| observations | observations | false | observations of a portability |
| infoTariff | infoTariff | false | info tariff of a portability |
| internal | internal | false | is a portability between own operators |
| isCancellable | isCancellable | false | is a portability cancellable |
| accessPhoneRanges | accessPhoneRanges | false | none |
| eventList | [event] | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | acceptDonorPortabilityRequest | true | ‘none’ |
Request body - instance of acceptDonorPortabilityRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| processId | processIdMandatory | true | process id in Portanet |
| phoneRanges | phoneRanges | false | none |
| observations | observations | false | observations of a portability |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Accept ok | portabilityInfo |
| 400 | Bad Request | Invalid body | errorResponse |
| 404 | Not Found | Portability not found | errorResponse |
| 405 | Method Not Allowed | Portability is not in progress | errorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | denyDonorPortabilityRequest | true | ‘none’ |
Request body - instance of denyDonorPortabilityRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| processId | processIdMandatory | true | process id in Portanet |
| causeCode | causeCodeMandatory | true | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| administrative | administrative | false | administrative access number |
| accessPhoneRanges | accessPhoneRanges | false | none |
| observations | observations | false | observations of a portability |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Deny ok | portabilityInfo |
| 400 | Bad Request | Invalid body | errorResponse |
| 404 | Not Found | Portability not found | errorResponse |
| 405 | Method Not Allowed | Portability is not in progress | errorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | portabilityInfo | true | ‘none’ |
Request body - instance of portabilityInfo
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneRanges | phoneRanges | false | none |
| stateId | stateId | false | portability state |
| messageType | messageType | false | Message type Portabaility |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
| recipientRol | recipientRol | true | operator rol recipient or donor |
| processId | processId | true | process id in Portanet |
| recipientOperator | recipientOperator | false | current recipient operator code |
| donorOperator | donorOperator | false | initial donor operator code |
| requestDate | requestDate | false | request date for portability |
| messageDate | messageDate | false | date to send to Portanet |
| windowDate | windowDate | false | portability window |
| cancellationDate | cancellationDate | false | cancellation date |
| processType | processType | false | process type |
| administrative | administrative | false | administrative access number |
| lluProcessId | lluProcessId | false | local loop unbundling identifier |
| fullNumberFlag | fullNumberFlag | false | full number flag |
| wholesalerFlag | wholesalerFlag | false | wholesaler flag |
| accessType | accessType | false | portability access type |
| donorResellerOperator | donorResellerOperator | false | donor reseller operator |
| recipientResellerOperator | recipientResellerOperator | false | recipient reseller operator |
| subscriber | subscriber | false | none |
| causeCode | causeCode | false | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| observations | observations | false | observations of a portability |
| infoTariff | infoTariff | false | info tariff of a portability |
| internal | internal | false | is a portability between own operators |
| isCancellable | isCancellable | false | is a portability cancellable |
| accessPhoneRanges | accessPhoneRanges | false | none |
| eventList | [event] | false | none |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Patch ok | portabilityInfo |
| 400 | Bad Request | Invalid body | None |
| 404 | Not Found | Portability not found | None |
200 - instance of portabilityInfo
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneRanges | phoneRanges | false | none |
| stateId | stateId | false | portability state |
| messageType | messageType | false | Message type Portabaility |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
| recipientRol | recipientRol | true | operator rol recipient or donor |
| processId | processId | true | process id in Portanet |
| recipientOperator | recipientOperator | false | current recipient operator code |
| donorOperator | donorOperator | false | initial donor operator code |
| requestDate | requestDate | false | request date for portability |
| messageDate | messageDate | false | date to send to Portanet |
| windowDate | windowDate | false | portability window |
| cancellationDate | cancellationDate | false | cancellation date |
| processType | processType | false | process type |
| administrative | administrative | false | administrative access number |
| lluProcessId | lluProcessId | false | local loop unbundling identifier |
| fullNumberFlag | fullNumberFlag | false | full number flag |
| wholesalerFlag | wholesalerFlag | false | wholesaler flag |
| accessType | accessType | false | portability access type |
| donorResellerOperator | donorResellerOperator | false | donor reseller operator |
| recipientResellerOperator | recipientResellerOperator | false | recipient reseller operator |
| subscriber | subscriber | false | none |
| causeCode | causeCode | false | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| observations | observations | false | observations of a portability |
| infoTariff | infoTariff | false | info tariff of a portability |
| internal | internal | false | is a portability between own operators |
| isCancellable | isCancellable | false | is a portability cancellable |
| accessPhoneRanges | accessPhoneRanges | false | none |
| eventList | [event] | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | changeNrn | true | ‘none’ |
Request body - instance of changeNrn
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| recipientOperator | recipientOperatorMandatory | true | current recipient operator code |
| initialRange | initialRange | true | intial phone number range |
| endRange | endRange | true | end phone number range |
| nrnRange | nrnRange | true | nrn range |
| windowDate | windowDateMandatory | true | portability window |
| observations | observations | false | observations of a portability |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Change NRN in progress | portabilityInfo |
| 400 | Bad Request | Invalid body | None |
200 - instance of portabilityInfo
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneRanges | phoneRanges | false | none |
| stateId | stateId | false | portability state |
| messageType | messageType | false | Message type Portabaility |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
| recipientRol | recipientRol | true | operator rol recipient or donor |
| processId | processId | true | process id in Portanet |
| recipientOperator | recipientOperator | false | current recipient operator code |
| donorOperator | donorOperator | false | initial donor operator code |
| requestDate | requestDate | false | request date for portability |
| messageDate | messageDate | false | date to send to Portanet |
| windowDate | windowDate | false | portability window |
| cancellationDate | cancellationDate | false | cancellation date |
| processType | processType | false | process type |
| administrative | administrative | false | administrative access number |
| lluProcessId | lluProcessId | false | local loop unbundling identifier |
| fullNumberFlag | fullNumberFlag | false | full number flag |
| wholesalerFlag | wholesalerFlag | false | wholesaler flag |
| accessType | accessType | false | portability access type |
| donorResellerOperator | donorResellerOperator | false | donor reseller operator |
| recipientResellerOperator | recipientResellerOperator | false | recipient reseller operator |
| subscriber | subscriber | false | none |
| causeCode | causeCode | false | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| observations | observations | false | observations of a portability |
| infoTariff | infoTariff | false | info tariff of a portability |
| internal | internal | false | is a portability between own operators |
| isCancellable | isCancellable | false | is a portability cancellable |
| accessPhoneRanges | accessPhoneRanges | false | none |
| eventList | [event] | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | cancelChangeNrn | true | ‘none’ |
Request body - instance of cancelChangeNrn
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| processId | processIdMandatory | true | process id in Portanet |
| causeCode | causeCodeMandatory | true | cause code of a denied operation |
| observations | observations | false | observations of a portability |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Cancel change NRN in progress | portabilityInfo |
| 400 | Bad Request | Invalid body | None |
200 - instance of portabilityInfo
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| phoneRanges | phoneRanges | false | none |
| stateId | stateId | false | portability state |
| messageType | messageType | false | Message type Portabaility |
| externalReference | externalReference | false | externalReference associated |
| brand | brand | false | brand associated |
| recipientRol | recipientRol | true | operator rol recipient or donor |
| processId | processId | true | process id in Portanet |
| recipientOperator | recipientOperator | false | current recipient operator code |
| donorOperator | donorOperator | false | initial donor operator code |
| requestDate | requestDate | false | request date for portability |
| messageDate | messageDate | false | date to send to Portanet |
| windowDate | windowDate | false | portability window |
| cancellationDate | cancellationDate | false | cancellation date |
| processType | processType | false | process type |
| administrative | administrative | false | administrative access number |
| lluProcessId | lluProcessId | false | local loop unbundling identifier |
| fullNumberFlag | fullNumberFlag | false | full number flag |
| wholesalerFlag | wholesalerFlag | false | wholesaler flag |
| accessType | accessType | false | portability access type |
| donorResellerOperator | donorResellerOperator | false | donor reseller operator |
| recipientResellerOperator | recipientResellerOperator | false | recipient reseller operator |
| subscriber | subscriber | false | none |
| causeCode | causeCode | false | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
| observations | observations | false | observations of a portability |
| infoTariff | infoTariff | false | info tariff of a portability |
| internal | internal | false | is a portability between own operators |
| isCancellable | isCancellable | false | is a portability cancellable |
| accessPhoneRanges | accessPhoneRanges | false | none |
| eventList | [event] | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | forceDownloadPortanetFileRequest | true | ‘none’ |
Request body - instance of forceDownloadPortanetFileRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| ftpFile | string | true | Ftp file name |
| operatorId | string | true | operator code |
| date | string(date) | true | file date |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download in process | None |
| 400 | Bad Request | Invalid body | None |
| 404 | Not Found | Invalid ftpFile, operator code or flow | None |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | forceDownloadStorage | true | ‘none’ |
Request body - instance of forceDownloadStorage
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| ftpFile | string | true | Ftp file name |
| operatorId | string | true | operator code |
| date | string(date) | true | file date |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Download in process | None |
| 400 | Bad Request | Invalid body | None |
| 404 | Not Found | Invalid ftpFile, operator code or flow | None |
Endpoints
Portabilities
Migrations
Acquisitions
Operations
Producers
Impersonate