Available from CRM.COM R7.0.0 and up to CRM.COM R11
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:
| ||||||||||||
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:
| ||||||||||||
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 | ||||||||||||
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
- N/A
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "7AE67C834D964C0ABE2C92ADD063C8FC",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"},
"services_set" : [
{
"service_identifier" : { "code" : "Gold" }
}
] ,
"priority":"EXPRESS"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"scheduled_date": "2015-09-07T15:03:33",
"response": null,
"error_code": null,
"priority": "EXPRESS",
"error_description": null,
"sequence_number": null,
"number": "18570",
"process_id": null,
"name": null,
"parameters_set":
[
{
"service_ca_id": null,
"id": "F5B3462375494E9E9D8C97C6367447A0"
},
{
"id": "F292CE55AE104109A563C5FFB4EE17D7"
},
{
"sub_provisioning_distribution_id": "F96FA9E55B12476BB45508349D885D10",
"id": "F9F0231FC91E4B7692E9ED89D406C74F"
},
{
"id": "8E8E8E1C2434484B98AB11B41394D56D"
},
{
"smartcard_ca_id": "smrt200000",
"id": "28D68AF59B4940229EB929002BD92407"
}
],
"process_immediately": 0,
"request": null,
"log_information":
{
"updated_date": "2015-09-07T15:03:33",
"created_date": "2015-09-07T15:03:28",
"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": "ADD_ENHANCED_LIST_OF_PRODUCTS",
"process_name": "PROVISIONING_REQUEST_PROCESSING_RUN",
"id": "751427A869C84129BA5C2184745A7447",
"reference_number": null,
"executed_date": null
}
}
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:
| ||||||||||||
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:
| ||||||||||||
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 | ||||||||||||
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.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "3158CF887E934C4881B06FD48C8A64C2",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"},
"services_set" : [
{
"service_identifier" : {"code" : "Cartoons 1" }
}
],
"priority":"EXPRESS"
}
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
{
"scheduled_date": "2015-09-07T15:23:15",
"response": null,
"error_code": null,
"priority": "EXPRESS",
"error_description": null,
"sequence_number": null,
"number": "18572",
"process_id": null,
"name": null,
"parameters_set":
[
{
"id": "DAA117D8CF7A4BE5A69A356A9050748C"
},
{
"sub_provisioning_distribution_id": "98E0E6CA6B7E49D6A031C1A3665EA159",
"id": "06C940F365FA4DE99D4631AA691BB452"
},
{
"id": "209B2DBB6F614A5BB1F41B96B57E586C"
},
{
"smartcard_ca_id": "smrt200000",
"id": "1BDC07C09CC34D9796CC8B70D63FBBEF"
},
{
"service_ca_id": null,
"id": "291325B4C99A49D8843EE2BCAFBB373E"
}
],
"process_immediately": 0,
"request": null,
"log_information":
{
"updated_date": "2015-09-07T15:23:15",
"created_date": "2015-09-07T15:23:15",
"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": "CANCEL_LIST_OF_PRODUCTS",
"process_name": "PROVISIONING_REQUEST_PROCESSING_RUN",
"id": "013CADB728044AE193DCFCBEB0926E52",
"reference_number": null,
"executed_date": null
}
}
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:
| ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
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
Response Data
Examples
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
}
}
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:
| ||||||||||||
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 | ||||||||||||
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.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "56C91A25B081415495861A60F631E763",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}
Response:
{
"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:
| ||||||||||||
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 | ||||||||||||
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.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "0D6220A6CD2F435CB0F73234269200F2",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"},
"pin" : "1234"
}
Response:
{
"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:
| ||||||||||||
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 | ||||||||||||
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.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "A7AD3752AC7B48099A80E62C8F0BE565",
"subscription_identifier" : { "number" : "S60507" },
"smartcard_identifier" : { "serial_number" : "smrt20000054"}
}
Response:
{
"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
}
}