Phone number portability¶
It is possible to know the eligibility for portability on a phone number by doing a GET on the url
/api/eligibility/endpoints/{endpoint_ref}/portability/.
Response¶
A list of dictionaries representing supplier eligibility is returned by Covage.
Field Name  | 
Type  | 
Description  | 
|---|---|---|
provider  | 
string  | 
Operator Name (  | 
type  | 
string  | 
Portability type  | 
quarantine_end_date  | 
datetime  | 
End date of quarantine  | 
eligibility  | 
dict  | 
Portability information  | 
Field type¶
The different portability types are:
Code  | 
Portability type  | 
|---|---|
  | 
Port in  | 
  | 
Port in back  | 
  | 
Subsequent port in  | 
  | 
Port out  | 
  | 
Subsequent  | 
Champ eligibility¶
In case of non-eligibility, the eligible field will be equal to false and the reasons for non-eligibility will be listed in the reasons field.
Field Name  | 
Type  | 
Description  | 
|---|---|---|
eligible  | 
boolean  | 
Defines whether the number is eligible for portability. May be   | 
under_conditions  | 
dict list  | 
Contains the list of warnings to be taken into account when the number is eligible for portability.  | 
reasons  | 
dict list  | 
Contains the list of reasons why the number is not eligible for portability.  | 
Field reasons¶
The reasons field is a list of dictionaries in the form:
Field Name  | 
Type  | 
Description  | 
|---|---|---|
code  | 
string  | 
Technical code representing the reason for non-eligibility  | 
message  | 
string  | 
Reason for non-eligibility in text form  | 
The table below lists the possible non-eligibility codes.
Code  | 
Description  | 
|---|---|
2006  | 
Orange must check the possibility of maintaining this number Absence ZNE or territorial area or ambiguity (address with NDs from several zones)  | 
2011  | 
Announcement in progress with another operator  | 
2102  | 
ND belonging to a sequence of N° not reached. Number to be taken out of the sequence  | 
2103  | 
Command in progress  | 
2104  | 
Insufficient data to evaluate the command.  | 
2105  | 
Basic inconsistency, Temporarily non portable number  | 
3009  | 
ARCEP numbering plan not respected  | 
3011  | 
Announcement in progress with another operator  | 
3012  | 
Different ZNE  | 
3013  | 
Different territorial areas  | 
3014  | 
ND worn for service reasons  | 
3031  | 
Line under construction  | 
3040  | 
Portability anomaly  | 
3041  | 
Orange is neither the assignor nor the operator to which the number belongs  | 
3043  | 
Number portability was not requested by the current operator  | 
3044  | 
Orange is not transferring operator  | 
3045  | 
Offering domain not compatible with “SDA”  | 
3046  | 
Orange is not the operator holding the number  | 
3047  | 
Unjustified order  | 
3048  | 
The operator does not own the fleet to be modified  | 
3049  | 
The operator holds the fleet to be modified  | 
Example¶
GET /api/eligibility/endpoints/0145247000/portability/ HTTP/1.1
Host: extranet.kosc-telecom.fr
HTTP/1.1 200 OK
Content-Type: application/json
[
    {
        "provider": "KOSC",
        "type": null,
        "quarantine_end_date": null,
        "eligibility": {
            "under_conditions": null,
            "eligible": true,
            "reasons": null
        }
    },
    {
        "provider": "Other",
        "type": null,
        "quarantine_end_date": null,
        "eligibility": {
            "under_conditions": null,
            "eligible": false,
            "reasons": [
                {
                    "message": "L'opérateur détient le parc à modifier",
                    "code": "3049"
                }
            ]
        }
    }
]
Errors¶
In the case of an error, an HTTP 400 code is returned and the JSON error field returned will contain one of the following errors.
Error in query data  | 
The feasibility service cannot answer you at this time. Please renew your connection later  | 
Problem with the data pool  | 
The “ND” is not written correctly  | 
The “ND” has an incorrect field number  | 
Designation number (ND) not assigned  | 
The number entered is part of a grouping of lines. To verify the eligibility of this grouping, please renew the request from the main number of this facility  | 
Identifier of an unauthorized offer  | 
Inconsistency in query data (address code error)  | 
The requested call number is not currently in service or is not known to our system  | 
ZNE unknown  | 
The call number requested is not an in-service number  | 
Request type is unknown  | 
Operator must be FT (ARIANE code = 000001)  | 
Operator must not be FT  | 
Unknown operator  | 
Order unknown  | 
Order forbidden  |