Skip to end of banner
Go to start of banner

nagravision

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Available from CRM.COM R6.0.0

 

 

POST nagravision/provisioning_requests/add_enhanced_list_of_products

This method is creating Add Enhanced List of Products provisioning requests in a pending life cycle state, by specifying the smartcard and the set of services which should be activated on the smartcard.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

Subscription Identifier

The subscription that the service to be added belongs to. The available subscription identifier fields are the following:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

services_set

(mandatory)

Services Set

The set of services that should be added. Only products classified as services can be specified. The available service identifier fields are the following:

Unable to render {include} The included page could not be found.

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

process_immediately

(optional)

booleanDefines if the provisioning request will be processed immediately after its creation. If enabled then the provisioning request will be sent through TCP request 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

Restrictions

  • N/A

Response Data

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 

 

Response:

            

POST nagravision/provisioning_requests/cancel_list_of_products

This method is creating Cancel List of Products provisioning requests in a pending life cycle state, by specifying the set of services and the smartcard that should be cancelled, and the subscription that the service should belong to.

Resource URL

Parameters

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

services_set

(mandatory)

Services set

The set of services that should be cancelled. Only products classified as services can be specified. The available product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of  the product

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

process_immediately

(optional)

booleanDefines 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

 

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 

 

 

Response:

            

POST nagravision/provisioning_requests/pair_smartcard_decoder

This method is creating Pair Smartcard & STB pairing provisioning requests in a pending life cycle state, by specifying the Smartcard and STB that should be paired.

Resource URL

Parameters

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

process_immediately

(optional)

booleanDefines 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

smartcard_identifier

( mandatory)

Installed Item IdentifierThe smartcard that will be paired or unpaired with an STB.

Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

stb_identifier

(semi-optional))

Installed Item IdentifierThe STB that will be paired or unpaired with a Smartcard. If no STB is specified, then this will trigger the specified Smartcard to be unpaired with the STB with which it was previously paired.

Only installed items classified as STBs through the provisioning provider can be specified. The available installed item identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of  a installed item

 

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified

Response Data

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 

 

 

Response:

   

 

POST nagravision/provisioning_requests/set_pin_to_default_value

This method is creating Set pin code to default value provisioning requests in a pending life cycle state, by specifying the smartcard that should be reset, and the subscription that the smartcard should belong to.

Resource URL

Parameters

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

smartcard_ca_id

(mandatory)

String

The smartcard CA ID that should be reset.

process_immediately

(optional)

booleanDefines 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

 

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 

 

Response:

 

POST nagravision/provisioning_requests/set_pin_to_given_value

This method is creating Set pin to given value provisioning requests in a pending life cycle state, by specifying the smartcard that should be reset, the new pin value, and the subscription that the smartcard should belong to.

Resource URL

Parameters

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

smartcard_ca_id

(mandatory)

String

The smartcard CA ID that should be reset.

 

pin

(mandatory)

 StringThe new pin value

process_immediately

(optional)

booleanDefines 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

 

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

 

 

Response:

       
           

 

POST nagravision/provisioning_requests/clear_pin

This method is creating Clear pin code provisioning requests in a pending life cycle state, by specifying the smartcard that should be reset, and the subscription that the smartcard should belong to.

Resource URL

Parameters

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:

Name

Type

Description

id 

(semi-optional)

String

The ID of subscription

number 

(semi-optional)

String

The number of subscription

smartcard_ca_id

(mandatory)

String

The smartcard CA ID that should be reset.

process_immediately

(optional)

booleanDefines 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Examples

HTTP Method: POST

 

Request:

Body:

 

 

Response:

 
  • No labels