Tip
Available from CRM.COM R7.0.0

Table of Contents

maxLevel	2

...

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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:

Include Page

	product_ident
	product_ident

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:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

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 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

...

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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:

Include Page

	V4:product_identifier
	V4:product_identifier

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:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

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

...

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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

smartcard_identifier

( mandatory)

Installed Item Identifier

The 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:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

stb_identifier

(semi-optional))

Installed Item Identifier

The 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:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

...

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

smartcard_ca_id

(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

...

Examples

Expand

title	Example 1

...

subscription_identifier

(mandatory)

...

The subscription that the smartcard to be reset belongs to. The available subscription identifier fields are the following:

...

smartcard_ca_id

(mandatory)

...

The smartcard CA ID that should be reset.

...

(mandatory)

...

process_immediately

(optional)

...

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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)

...

The subscription that the smartcard to be reset belongs to. The available subscription identifier fields are the following:

...

smartcard_ca_id

(mandatory)

...

The smartcard CA ID that should be reset.

...

process_immediately

(optional)

...

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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token"	: "56C91A25B081415495861A60F631E763",
	"subscription_identifier" : { "number" : "S60507" },
	"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-09-07T17:46:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18576",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
                   "id": "A8BD38B9BA2542308618882D20D454EA"
               },
               {
                   "id": "8C006115BCB94007A85EB60C608568B3"
               },
               {
                   "id": "24EB6D1131004AEC8EFE15C033E41225"
               },
               {
                   "smartcard_ca_id": "smrt200000",
                   "id": "C5FF9B1247A2414D8D121FD1879A35FE"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-09-07T17:46:45",
               "created_date": "2015-09-07T17:46:45",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "life_cycle_state": "PENDING",
           "type": "UPDATE_CA_PIN_TO_DEFAULT_VALUE",
           "process_name": "RESET_PIN_CODE_UTILITY",
           "id": "C61B04EE7E3443E1B57B5454513A58AA",
           "reference_number": null,
           "executed_date": null
       }
    }

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

smartcard_ca_id

(mandatory)

String

The smartcard CA ID that should be reset.

(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

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

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token"	: "0D6220A6CD2F435CB0F73234269200F2",
	"subscription_identifier" : { "number" : "S60507" },
	"smartcard_identifier" : { "serial_number" : "smrt20000054"},
	"pin" : "1234"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-09-07T17:48:03",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18578",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "id": "C11077AA433C42EEAD4A352EAE5E0756"
               },
               {
                   "sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
                   "id": "472EF033EDA549C2A05BF9956FF9DB57"
               },
               {
                   "id": "0A203267718841B583117BF8BFAE35D0"
               },
               {
                   "ca_pin": null,
                   "id": "04C63BB7E28D48909AC99027889266DD"
               },
               {
                   "smartcard_ca_id": "smrt200000",
                   "id": "D9759E2571424CC099CB372942D85E79"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-09-07T17:48:03",
               "created_date": "2015-09-07T17:48:03",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "life_cycle_state": "PENDING",
           "type": "UPDATE_CA_PIN_TO_GIVEN_VALUE",
           "process_name": "RESET_PIN_CODE_UTILITY",
           "id": "622562667EC74F0F807866B4B87C0C57",
           "reference_number": null,
           "executed_date": null
       }
    }

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

smartcard_ca_id

(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

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:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token"	: "A7AD3752AC7B48099A80E62C8F0BE565",
	"subscription_identifier" : { "number" : "S60507" },
	"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-09-07T17:56:11",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18579",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "id": "F858F07C2AFB4020988F40E5E36D308B"
               },
               {
                   "smartcard_ca_id": "smrt200000",
                   "id": "8D90C87F9EBF4DB0B54C44DFB4DD2E6E"
               },
               {
                   "id": "79D362BC51724DC99A62A597A15939B5"
               },
               {
                   "sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
                   "id": "FD9A9DC80EAA4A8F810F214592F3D5DD"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-09-07T17:56:11",
               "created_date": "2015-09-07T17:56:11",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "life_cycle_state": "PENDING",
           "type": "CLEAR_CA_PIN",
           "process_name": "RESET_PIN_CODE_UTILITY",
           "id": "D62E639909C64F648AF480C66BF59FF9",
           "reference_number": null,
           "executed_date": null
       }
    }

Versions Compared

Old Version 7

New Version 8

Key

Examples

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/clear_pin

Resource URL

Parameters

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/set_pin_to_given_value

Resource URL

Parameters

POST nagravision/provisioning_requests/set_pin_to_given_value

Resource URL

Parameters

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/clear_pin

Resource URL

Parameters

Restrictions

Response Data

Examples

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

Examples

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/clear_pin

Resource URL

Parameters

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/set_pin_to_given_value

Resource URL

Parameters

POST nagravision/provisioning_requests/set_pin_to_given_value

Resource URL

Parameters

Restrictions

Response Data

Examples

POST nagravision/provisioning_requests/clear_pin

Resource URL

Parameters

Restrictions

Response Data

Examples