Provision Orange TV

Activate a subscription

POST /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.
body	body	ActivateSubscription	true	‘none’

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


{
  "email": "email@emil.com",
  "firstName": "First name",
  "lastName": "Last name",
  "ftthWorkOrderId": "MYSIM_123456",
  "maxStb": "Max stb",
  "maxTerminals": "max terminals",
  "password": "pass1234",
  "postalCode": 987564,
  "segment": "Segment",
  "phoneNumber": 40828383874,
  "spId": "spId",
  "spendingLimit": 1234554,
  "customerType": "iptv/ott",
  "servicePlan": [
    "spId-1",
    "spId-2",
    "spId-3"
  ],
  "externalID": "external_subscription_12345",
  "ftthServiceID": "ftth_service_67890"
}

Name	Type	Required	Description
email	Email	false	Email
firstName	FirstName	true	First Name
lastName	LastName	true	Last name
ftthWorkOrderId	FtthWorkOrderId	false	FTTH work order identifier
maxStb	MaxStb	false	Max stb
maxTerminals	MaxTerminals	true	Max terminals
password	Password	false	password
postalCode	PostalCode	false	Postal code
segment	Segment	false	Segment
phoneNumber	PhoneNumber	false	Phone number
spId	SpId	true	Sp id
spendingLimit	SpendingLimit	false	Spending limit
customerType	CustomerType	true	Customer type
servicePlan	ServicePlan	false	Service plan for creation without FTTH
externalID	ExternalID	false	Identifier of the subscription on the CRM
ftthServiceID	FtthServiceID	false	For north brands where we don’t have the order on wo_data, we use ftthServiceId.

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
28



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'email': 'email@emil.com',
  'firstName': 'First name',
  'lastName': 'Last name',
  'ftthWorkOrderId': 'MYSIM_123456',
  'maxStb': 'Max stb',
  'maxTerminals': 'max terminals',
  'password': 'pass1234',
  'postalCode': 987564,
  'segment': 'Segment',
  'phoneNumber': 40828383874,
  'spId': 'spId',
  'spendingLimit': 1234554,
  'customerType': 'iptv/ott',
  'servicePlan': [
    'spId-1',
    'spId-2',
    'spId-3'
  ],
  'externalID': 'external_subscription_12345',
  'ftthServiceID': 'ftth_service_67890'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Subscription activated successfully.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Update a subscription

PATCH /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.
body	body	ModifySubscription	true	‘none’

Request body - JsonObject

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13


{
  "segment": "Segment",
  "servicePlanToAdd": [
    "spId-1",
    "spId-2",
    "spId-3"
  ],
  "servicePlanToDelete": [
    "spId-1",
    "spId-2",
    "spId-3"
  ]
}

Name	Type	Required	Description
segment	Segment	false	Segment
servicePlanToAdd	ServicePlanToAdd	true	Service type list to add
servicePlanToDelete	ServicePlanToDelete	true	Service type list to delete

Request example

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



curl -X PATCH https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'segment': 'Segment',
  'servicePlanToAdd': [
    'spId-1',
    'spId-2',
    'spId-3'
  ],
  'servicePlanToDelete': [
    'spId-1',
    'spId-2',
    'spId-3'
  ]
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Subscription modified successfully.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Terminate a subscription

DELETE /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.

Request example

1
2
3
4
5



curl -X DELETE https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067 \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code	Meaning	Description	Schema
201	Created	Subscription terminated successfully.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Suspend a subscription

Suspends an active subscription.

POST /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}/suspend

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.

Request example

1
2
3
4
5



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067/suspend \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code	Meaning	Description	Schema
201	Created	Subscription suspended successfully.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Reactivate a subscription

Reactivates a previously suspended subscription.

POST /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}/reactivate

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.

Request example

1
2
3
4
5



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067/reactivate \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code	Meaning	Description	Schema
201	Created	Subscription reactivated successfully.	WorkflowResponse
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Cancel a subscription in progress

Cancels an in-progress subscription providing the creationWorkflowId.

POST /orgs/{org}/provision/tv/orange/subscriptions/{subscriptionExternalId}/cancel

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
subscriptionExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.
body	body	CancelSubscriptionRequest	true	‘none’

Request body - instance of CancelSubscriptionRequest

1
2
3


{
  "creationWorkflowId": "provision_OrangeTvActivationWf_33348e03-7b85-4cf9-a933-a04e74766acb"
}

Name	Type	Required	Description
creationWorkflowId	string	true	none

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/subscriptions/913259067/cancel \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'creationWorkflowId': 'provision_OrangeTvActivationWf_33348e03-7b85-4cf9-a933-a04e74766acb'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Subscription canceled successfully.	None
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
406	Not Acceptable	Not Acceptable	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Modify customer attributes

PATCH /orgs/{org}/provision/tv/orange/customers/{customerExternalId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
customerExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.
body	body	ModifyCustomer	true	‘none’

Request body - JsonObject

1
2
3
4
5
6
7
8


{
  "ftthWorkOrderId": "MYSIM_123456",
  "password": "pass1234",
  "parentalPin": "1234",
  "email": "email@emil.com",
  "postalCode": 987564,
  "spendingLimit": 1234554
}

Name	Type	Required	Description
ftthWorkOrderId	FtthWorkOrderId	false	FTTH work order identifier
password	Password	false	password
parentalPin	ParentalPin	false	Parental PIN
email	Email	false	Email
postalCode	PostalCode	false	Postal code
spendingLimit	SpendingLimit	false	Spending limit

Request example

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



curl -X PATCH https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/customers/913259067 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)" \
 --data-raw "{
  'ftthWorkOrderId': 'MYSIM_123456',
  'password': 'pass1234',
  'parentalPin': '1234',
  'email': 'email@emil.com',
  'postalCode': 987564,
  'spendingLimit': 1234554
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Customer updated successfully.	None
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Get devices

GET /orgs/{org}/provision/tv/orange/customers/{customerExternalId}/devices

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
customerExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.

Request example

1
2
3
4
5



curl -X GET https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/customers/913259067/devices \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code	Meaning	Description	Schema
200	OK	Get devices request successful.	[Terminal]
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]

Delete a device

DELETE /orgs/{org}/provision/tv/orange/customers/{customerExternalId}/devices/{serialNumber}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Tenant
Request-Correlation-Id	header	string	true	A reference for this transaction that can be used to track it.
customerExternalId	path	string	true	Partner user identifier in OrangeTV. It’s the Id in CRM.
serialNumber	path	string	true	device serial number

Request example

1
2
3
4
5



curl -X DELETE https://provision-master.private.dev.k8s.masmovil.com/v1/orgs/pepephone/provision/tv/orange/customers/913259067/devices/123123123 \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: Workflow Id (unique identifier)"

Responses

Code	Meaning	Description	Schema
204	No Content	Device deleted successfully.	None
400	Bad Request	Bad Request	[Error]
401	Unauthorized	Unauthorized request	[Error]
404	Not Found	Not Found	[Error]
500	Internal Server Error	Internal Server Error	[Error]