| Tip |
|---|
Available from CRM.COM R4.0.0 |
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| provisioning_request_identifier (semi-optional) | Provisioning Request identifier | The identifier of the provisioning request that should be returned as a result. The allowed provisioning request identifier fields are the following:
| ||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||
token | String | The token retrieved from the login method | ||
type | String | The type of the provisioning request to be retrieved. The supported types are the following:
| ||
life_cycle_state (semi-optional) | String | The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED | ||
reference_number (semi-optional) | String | The reference number of the provisioning request as provided by Conax after receiving the request | ||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription that the service to be added belongs to. The available subscription identifier fields are the following:
| ||||||
service_identifier (mandatory) | Product identifier | The service that should be added. Only products classified as services can be specified. The available product identifier fields are the following:
| ||||||
smartcard_identifier (mandatory) | Installed Item identifier | The smartcard that the service should be added on. Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:
| ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
start_date (optional) | String | The date that the provisioning request will be appied. If not specified then it is set to the date that the request is submitted | ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately.
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription that the service to be cancelled belongs to. The available subscription identifier fields are the following:
| ||||||
service_identifier (mandatory) | Product identifier | The service that should be cancelled. Only products classified as services can be specified. The available product identifier fields are the following:
| ||||||
smartcard_identifier (mandatory) | Installed Item identifier | The smartcard that the service should be added on. Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:
| ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
start_date (optional) | String | The date that the provisioning request will be applied. If not specified then it is set to the date that the request is submitted | ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (optional) | Subscription identifier | The subscription that the pairing might belongs to. The available subscription identifier fields are the following:
| ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately
| ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
( mandatory) | Conax Web Services Smartcard objects | The smartcards that will be paired | ||||||
(mandatory) | Conax Web Services STB objects | The STBs that will be paired |
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (optional) | Subscription identifier | The subscription that the pairing might belongs to. The available subscription identifier fields are the following:
| ||||||
smartcard_identifier (mandatory) | String | The smartcard CA ID that identifies the existing pairing
| ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately
| ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
(semi-optional) | Conax Web Services Smartcard objects | The smartcards that will be added in the pairing | ||||||
(semi-optional) | Conax Web Services STB objects | The STBs that will be added in the pairing |
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription that the smartcard to be reset belongs to. The available subscription identifier fields are the following:
| ||||||
smartcard_identifier (mandatory) | String | The smartcard CA ID that should be reset.
| ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription that the smartcard to be reset belongs to. The available subscription identifier fields are the following:
| ||||||
smartcard_identifier (mandatory) | String | The smartcard CA ID that should be reset.
| ||||||
pin (mandatory) | String | The new pin value | ||||||
process_immediately (optional) | boolean | Defines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through Web API during its creation. If not enabled then the provisioning request will be created and processed later on by the active provisioning request processing run. If not specified then the provisioning request will not be processed immediately | ||||||
priority (optional) | String | The priority of the provisioning request. The supported values are the following:
If not specified then it is set to REGULAR | ||||||
scheduled_date (optional) | Date | The date that the provisioning request is scheduled to be processed. If not specified and process_immediatelly is also set to false, then the provisioning request will be processed immediately
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...