POST nagravision/provisioning_requests/pair_smartcard_decoder

Available from CRM.COM R7.0.0 and up to CRM.COM R11

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

scheduled_date

(optional)

dateThe 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

Response Data

Examples

 Example 1

HTTP Method: POST

 

Request:

Body:

{
	"token"	: "0295D5B299724C6289BB8095A9550137",
	"subscription_identifier" : { "number" : "S60507" },
	"smartcard_identifier" : { "serial_number" : "smrt20000054"},
	"stb_identifier" : { "serial_number" : "dc1000015" }
}

 

 

 

Response:

    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-09-07T16:20:18",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18573",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "296D64F4D3A543B6AC4F4820F13FDC41",
                   "id": "E2C1D1204A664E09801AA16760D97F57"
               },
               {
                   "smartcard_ca_id": "smrt200000",
                   "id": "5120CAA77129433DAF26CFD11D92BB35"
               },
               {
                   "stb_sub_provisioning_distributor_id": "2AFAA4F8F8414032A135ACA9F44F6658",
                   "id": "913AFAFAF98A4DE0ABD202126373FDF3"
               },
               {
                   "id": "9350667B5B044D24A79A8530AA41FE5C"
               },
               {
                   "id": "B74CBF827FCA4BFBB729CEE556D82631",
                   "stb_ca_id": "dc1000015"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-09-07T16:20:18",
               "created_date": "2015-09-07T16:20:18",
               "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": "PAIR_SMARTCARD_AND_STB",
           "process_name": "PAIR_UTILITY",
           "id": "1BB9FFF404E94C5E87B1A8AFB45C2035",
           "reference_number": null,
           "executed_date": null
       }
    }  

Related pages