API Overview Resources Schemas

Provision FTTH

The FTTH API provide different endpoint to query information on the network. The api return information relationship the service that you are looking up.

Get customer data

Get customer data for specified query paramter

GET /ftth/accesses/info

Parameters

Name	In	Type	Required	Description
phoneNumber	query	string	false	Fixed phone number from access to be queried
gescal37	query	string	false	Alphanumeric value of 37 positions, subdivided into subfields that identify each of the geographical entities that comprise it.
addressId	query	string	false	Address id from access to be queried

Request example

1
2
3
4



curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v1/ftth/accesses/info?phoneNumber='900000000'&gescal37='28000000000000005BA'&addressId='J0000000000000000000000000000001553708' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Retrieved info	GetFtthAccesesInfoResponse
400	Bad Request	Invalid body supplied	errorResponseDto
401	Unauthorized	Unauthorized	errorResponseDto
403	Forbidden	Forbidden	errorResponseDto
404	Not Found	Data not found	errorResponseDto
406	Not Acceptable	Data not found	errorResponseDto
500	Internal Server Error	Something was wrong :(	errorResponseDto

Get orange access ftth

Get orange access ftth data for specified query parameter

GET /ftth/orange_accesses/info

Parameters

Name	In	Type	Required	Description
phoneNumber	query	string	false	Fixed phone number from access to be queried
gescal37	query	string	false	Alphanumeric value of 37 positions, subdivided into subfields that identify each of the geographical entities that comprise it.
addressId	query	string	false	Address id from access to be queried

Request example

1
2
3
4



curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v1/ftth/orange_accesses/info?phoneNumber='900000000'&gescal37='28000000000000005BA'&addressId='J0000000000000000000000000000001553708' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Retrieved info	FtthOrangeAccessResponse
400	Bad Request	Invalid body supplied	errorResponseDto
401	Unauthorized	Unauthorized	errorResponseDto
403	Forbidden	Forbidden	errorResponseDto
404	Not Found	Data not found	errorResponseDto
406	Not Acceptable	Data not found	errorResponseDto
500	Internal Server Error	Something was wrong :(	errorResponseDto

Inform a new retention of a client

The objective is to inform the customer retention option when a fixed access registration is taking place at the opposite brand. The purpose of this service is to inform the opposing brand of the retention option of a new convergent customer and the confirmation or not of the effectiveness of that retention.

POST /ftth/orange_accesses/retentions

Parameters

Name	In	Type	Required	Description
body	body	RetentionsRequest	true	Retentions request

Request body - JsonObject

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


{
  "reuseAccess": true,
  "source": {
    "gescal37": "string",
    "iua": "string",
    "phoneNumber": "string",
    "documentNumber": "string",
    "clientName": "string",
    "brand": "string"
  },
  "destination": {
    "gescal37": "string",
    "iua": "string",
    "phoneNumber": "string",
    "documentNumber": "string",
    "clientName": "string",
    "brand": "string",
    "bandwidth": "string",
    "customerType": "string",
    "tv": "OTT"
  }
}

Name	Type	Required	Description
reuseAccess	boolean	true	Reuse access
source	object	false	none
» gescal37	string	false	Gescal37 of the source client. Mandatory if reuseAccess=“true”
» iua	string	false	IUA of the source client. Mandatory if reuseAccess=“true”
» phoneNumber	string	false	Phone number of the source client. Mandatory if reuseAccess=“true”
» documentNumber	string	false	Document number of the source client. Mandatory if reuseAccess=“true”
» clientName	string	false	Client name of the source client. Mandatory if reuseAccess=“true”
» brand	string	false	Brand of the source client. Mandatory if reuseAccess=“true”
destination	object	true	none
» gescal37	string	true	Gescal37 of the destination client
» iua	string	false	IUA of the destination client
» phoneNumber	string	false	Phone number of the destination client
» documentNumber	string	false	Document number of the destination client
» clientName	string	false	Client name of the destination client
» brand	string	true	Brand of the destination client
» bandwidth	string	true	Contracted speed
» customerType	string	true	Segment of the destination client
» tv	string	false	TV contracted of the destination brand. Allowed values: OTT,IPTV,IPTV+OTT

Request example

 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



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/ftth/orange_accesses/retentions \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'reuseAccess': true,
  'source': {
    'gescal37': 'string',
    'iua': 'string',
    'phoneNumber': 'string',
    'documentNumber': 'string',
    'clientName': 'string',
    'brand': 'string'
  },
  'destination': {
    'gescal37': 'string',
    'iua': 'string',
    'phoneNumber': 'string',
    'documentNumber': 'string',
    'clientName': 'string',
    'brand': 'string',
    'bandwidth': 'string',
    'customerType': 'string',
    'tv': 'OTT'
  }
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Retrieved info	RetentionsResponse
400	Bad Request	Invalid body supplied	errorResponseDto
401	Unauthorized	Unauthorized	errorResponseDto
403	Forbidden	Forbidden	errorResponseDto
500	Internal Server Error	Something was wrong :(	errorResponseDto

Endpoints

Provision TV Amazon

Provision TV Netflix

Provision TV HBO

Provision FTTH

Provision Orange TV

Tesamanager

Mobile

Device Insurance