V3
Fixed portabilities
Access to portabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| processType | query | string | false | processType of the portability wanted to get the minimum windowDate. Default if missing is 15 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful operation | minimumWindowDate |
| 400 | Bad Request | Invalid parameter supplied | None |
200 - instance of minimumWindowDate
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| result | string | true | minimum window date |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| phonenumber | path | string | true | The cli phonenunber |
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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| phonenumber | path | string | true | The cli phonenunber |
| filters | query | string | false | Typical filters: donorOperator, 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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| externalReference | path | string | true | The external reference |
| 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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| processId | path | string | true | The Portanet identificator |
| 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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| dateField | path | string | true | The date field to filter: requestDate, messageDate, windowDate or cancellationDate |
| dateValue | path | string(date) | true | The value date |
| 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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| phonenumber | path | string | true | The cli phonenunber |
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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| phonenumber | path | string | true | The cli phonenunber |
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 |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| causeCode | path | string | true | Cause code |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful cause | [cause] |
| 404 | Not Found | Cause not found | None |
| 405 | Method Not Allowed | Validation exception | None |
200 - instance of cause
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| messageType | messageTypeMandatory | true | Message type Portabaility |
| causeCode | causeCodeMandatory | true | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| messageType | path | string | true | Message type |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful causes | [cause] |
| 404 | Not Found | Causes not found for message type | None |
| 405 | Method Not Allowed | Validation exception | None |
200 - instance of cause
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| messageType | messageTypeMandatory | true | Message type Portabaility |
| causeCode | causeCodeMandatory | true | cause code of a denied operation |
| causeDescription | causeDescription | false | cause description of a denied operation |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| year | path | string | true | the year to get the holidays calendar |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful call | [date] |
| 400 | Bad Request | validation exception | None |
200 - instance of date
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| anonymous | string(date) | false | date |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| orgId | path | string | true | ‘none’ |
| dateValue | path | string(date) | true | The value date |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | successful call | holiday |
| 400 | Bad Request | Validation exception | None |
200 - instance of holiday
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| isHoliday | boolean | true | return is holiday |
Endpoints
Fixed portabilities
Fixed migrations
Fixed acquisitions
Fixed operations
Fixed producers
Fixed impersonate