API Overview Resources Schemas

Schemas

portabilityCheck

1
2
3
4
5
6
7


{
  "number": "911234567",
  "territoryOwner": "FIBNEB01",
  "technicalId": "12345678901234567",
  "addressId": "M0000000000000000000000000000007042185",
  "technology": "FTTH"
}

Name	Type	Required	Description
number	string	true	Fixed number to be ported
territoryOwner	string	true	Territory owner. Not mandatory if technology is MIFIJO
technicalId	string	true	TechnicalId (corresponding with “GESCAL” ). Not mandatory if technology is MIFIJO. g17 or g37
addressId	string	false	Unique address ID
technology	string	true	Technology to be provided

Property	Values
technology	one of [FTTH, ADSL, MIFIJO]

accessCheck

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "originNumber": "911234567",
  "territoryOwner": "FIBNEB01",
  "technicalId": "12345678901234567",
  "addressId": "M0000000000000000000000000000007042185",
  "documentId": {
    "type": "NIF",
    "value": "11111111A"
  }
}

Name	Type	Required	Description
originNumber	string	false	Fixed number to be ported
territoryOwner	string	true	Territory owner.
technicalId	string	true	TechnicalId (corresponding with “GESCAL” ). g17 or g37
addressId	string	false	Unique address ID
documentId	documentId	true	none

documentId

1
2
3
4


{
  "type": "NIF",
  "value": "11111111A"
}

Name	Type	Required	Description
type	string	true	none
value	string	true	none

Property	Values
type	one of [CIF, NIE, NIF, Passport]

_getPortabilityConditions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


{
  "internalPortability": true,
  "isPortable": true,
  "installationRequired": false,
  "operator": {
    "code": "00031",
    "name": "XTRA"
  },
  "installationInformation": {
    "internalAccess": true,
    "iua": "V33904AHB202",
    "brand": "ORANGE",
    "number": "654321987",
    "documentNumber": "12345678Z",
    "gescal": "28000010276800007         006DCHA    "
  }
}

Name	Type	Required	Description
internalPortability	boolean	true	Determines whether the process is an internal portability or not
isPortable	boolean	true	Determines whether the number is portable
installationRequired	boolean	true	Determines whether a new installation is required
operator	operator	true	none
installationInformation	installationInformation	false	Available when FTTH access transfer

_getAccessCheck

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "installationRequired": false,
  "installationInformation": {
    "internalAccess": true,
    "iua": "V33904AHB202",
    "brand": "ORANGE",
    "number": "654321987",
    "documentNumber": "12345678Z",
    "gescal": "28000010276800007         006DCHA    "
  }
}

Name	Type	Required	Description
installationRequired	boolean	true	Determines whether a new installation is required
installationInformation	installationInformation	false	Available when FTTH access transfer

installationInformation

1
2
3
4
5
6
7
8


{
  "internalAccess": true,
  "iua": "V33904AHB202",
  "brand": "ORANGE",
  "number": "654321987",
  "documentNumber": "12345678Z",
  "gescal": "28000010276800007         006DCHA    "
}

Name	Type	Required	Description
internalAccess	boolean	true	internal or external access
iua	string	true	origin IUA
brand	string	false	Brand name
number	string	false	Client’s phone number
documentNumber	string	false	Client’s document number
gescal	string	false	Gescal address

operator

1
2
3
4


{
  "code": "00031",
  "name": "XTRA"
}

Name	Type	Required	Description
code	string	true	Operator code
name	string	true	Operator name

subscription_limit_active_request

1
2
3
4
5


{
  "document_type": "NIF",
  "document_id": "88662844Y",
  "segment": "Consumer"
}

Name	Type	Required	Description
document_type	string	false	client document type.
document_id	string	false	client document number.
segment	string	false	none

Property	Values
document_type	one of [NIF, CIF, NIE, PASSPORT, TR]
segment	one of [Consumer, SelfEmployee, SME, B2B]

subscription_limit_active_response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27


{
  "total_limit": 4,
  "total_active_subscriptions": 2,
  "total_subscriptions_allowed": 2,
  "specific_limits": [
    [
      {
        "type": "mobile",
        "limit": 3,
        "active_subscriptions": 2,
        "subscriptions_allowed": 1
      },
      {
        "type": "fixed",
        "limit": 1,
        "active_subscriptions": 0,
        "subscriptions_allowed": 1
      },
      {
        "type": "fixed",
        "limit": 1,
        "active_subscriptions": 0,
        "subscriptions_allowed": 1
      }
    ]
  ]
}

Name	Type	Required	Description
total_limit	integer	true	total limit from fraud
total_active_subscriptions	integer	true	active subscription for request type and client
total_subscriptions_allowed	integer	true	subscriptions allowed for a client
specific_limits	[object]	false	subscriptions of each type allowed for a client
» type	string	false	Subscription Type
» limit	integer	false	Limit of subscriptions allowed
» active_subscriptions	integer	false	Active subscriptions for a client
» subscriptions_allowed	integer	false	Allowed subscriptions that return fraud

Property	Values
type	one of [BROADBAND, FIXED, MOBILE]

not_found_response

1
2
3
4
5
6


{
  "code": "0001",
  "status": "NOT_FOUND",
  "message": "Resource Not Found",
  "detailMsg": "{Entity} not found for id: {id}"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

bad_request_response

1
2
3
4
5
6


{
  "code": "0015",
  "status": "BAD_REQUEST",
  "message": "Bad Request",
  "detailMsg": "The field '{fieldName}' is required"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none

error_response

1
2
3
4
5
6


{
  "code": "0002",
  "status": "UNEXPECTED",
  "message": "Unexpected error",
  "detailMsg": "Unhandled exception"
}

Name	Type	Required	Description
code	string	false	none
status	string	false	none
message	string	false	none
detailMsg	string	false	none