Page Comparison

Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

...

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:

Include Page

	V4:provisioning_request_identifier
	V4:provisioning_request_identifier

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 (semi-optional)	String	The type of the provisioning request to be retrieved. The supported types are the following: ADD_SUBSCRIPTIONS CANCEL_SUBSCRIPTIONS GET_ACTIVE_SUBSCRIPTIONS CREATE_PAIRING ADD_TO_EXISTING_PAIRING GET_PAIRING_STATUS_FOR_CARD GET_PAIRING_STATUS_FOR_PAIRING_MODULE DISPLAY_FINGERPRINT UPDATE_CA_PIN_TO_DEFAULT_VALUE UPDATE_CA_PIN_TO_GIVEN_VALUE SEND_MAIL_MESSAGE_TO_CLIENT SEND_BARK_MESSAGE_TO_CLIENT SEND_REPEATING_BARK_MESSAGE_TO_CLIENT
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
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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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:

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

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token": "04FFBB37FED475A778F122709CBAC1D5",
    "subscription_identifier":{"id":"98D375E905CD31F4CC780342525B2078"},
    "smartcard_identifier": {"id":"ABE63350738749C47F404687DA5E5A47"},      
    "service_identifier":{"id":"5C2DCFDD743632AC57AE8147B6EE665E"}, 
    "scheduledstart_date":"2014-11-30T09:00:00",
    "priority":"EXPRESS"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-11-30T09:00:00",
           "response": null,
           "error_code": null,
           "priority": "EXPRESS",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "23423",
                   "id": "C85CCA904FE8BF99C4B37FE710700869"
               },
               {
                   "service_ca_id": "P1test",
                   "id": "3F8DDA2C4608FF21843CFEB3FDDBA2B4"
               },
               {
                   "smartcard_ca_id": "stb01-3020-0005",
                   "id": "5FB6A0207DE74919C0A7C2F3737305AC"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-09-24T15:43:56",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-09-24T15:43:56",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "7630193CC386C7AF57B31EDAE931FD64",
           "process_name": null,
           "executed_date": null
       }
    }

...

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

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:

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

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{   
    "token": "04FFBB37FED475A778F122709CBAC1D5",
    "subscription_identifier":{"id":"98D375E905CD31F4CC780342525B2078"},
    "service_identifier":{"id":"5C2DCFDD743632AC57AE8147B6EE665E"},
    "smartcard_identifier":{"id":"ABE63350738749C47F404687DA5E5A47"},
    "scheduledstart_date":"2014-09-30T09:00:00",          
    "priority":"EXPRESS" 
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-09-30T09:00:00",
           "response": null,
           "error_code": null,
           "priority": "EXPRESS",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "service_ca_id": "P1test",
                   "id": "CA1473D15538AAAE7AA6F35234384857"
               },
               {
                   "smartcard_ca_id": "stb01-3020-0005",
                   "id": "E438C50CD0CC089E15C37DE0D0B0202F"
               },
               {
                   "sub_provisioning_distribution_id": "23423",
                   "id": "A9A324EDDD60DEDE7425C5BFEF96910A"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-09-24T15:39:53",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-09-24T15:39:53",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "CANCEL_SUBSCRIPTIONS",
           "id": "EB3DF4618C769E7B90C7C33316CF2376",
           "process_name": null,
           "executed_date": null
       }
    }

...

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

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

smartcard_set

( mandatory)

Conax Web Services Smartcard objects

The smartcards that will be paired

stb_set

(mandatory)

Conax Web Services STB objects

The STBs that will be paired

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{     
    "token": "E001458C75CE1BF191E227F172CF69EF",
    "subscription_identifier":{"id":"98D375E905CD31F4CC780342525B2078"},
    "smartcard_set": [{"smartcard_ca_id":"stb01-3020-0005"}],
    "stb_set": [{"stb_ca_id":"THMOD001-10002"}],
    "scheduled_date":"2014-10-30T09:00:00"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-10-30T09:00:00",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "id": "0E00CF63793A21302ED21E7CB5D0E826",
                   "stb_ca_id": "THMOD001-10002"
               },
               {
                   "smartcard_ca_id": "stb01-3020-0005",
                   "id": "8B8BAB8CD7E651E4CF42FCF0518850B8"
               },
               {
                   "stb_sub_provisioning_distributor_id": "DC8C40B2BD4CACB6D1339C12E9DD7F9A",
                   "id": "907416B03803425E9DB34516AF0658AE"
               },
               {
                   "smartcard_sub_provisioning_distribution_id": "D38DDF91D9005B116F9B02DBB4EA258A",
                   "id": "C32239BD7B893C669BA2C5930B151A33"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-10-07T17:07:48",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-10-07T17:07:47",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "CREATE_PAIRING",
           "id": "F63207AD7773D74AB96E414AEE8B6F66",
           "process_name": null,
           "executed_date": null
       }
    }

...

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

smartcard_ca_id

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

String

The date that the provisioning request will be appliedrun. If not specified then it is set to the date that the request is submittedthe provisioning request will not be processed immediately

priority

(optional)

String

The priority of the provisioning request. The supported values are the following:

REGULAR
EXPRESS

If not specified then it is set to REGULAR

smartcard_set

(semi-optional)

Conax Web Services Smartcard objects

The smartcards that will be added in the pairing

stb_set

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

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{     
    "token": "E001458C75CE1BF191E227F172CF69EF",
    "subscription_identifier":{"number":"S60058"},
    "smartcard_ca_id":"sc20000010",                 "scheduled_date":"2014-10-29T09:00:00"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-10-29T09:00:00",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "smartcard_sub_provisioning_distribution_id": "AD4377F035250EB92E8DBF5A97B5AF8B",
                   "id": "A8FA413E992B42FB5C2FE6D609085B9F"
               },
               {
                   "smartcard_ca_id": "sc20000010",
                   "id": "CB0FE4C65B882941BDCE39F591E9F57D"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-10-07T17:15:49",
               "created_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-10-07T17:15:49",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "UPDATE_CA_PIN_TO_DEFAULT_VALUE",
           "id": "DD59BBD1F02E929243C952E8B56733DC",
           "process_name": null,
           "executed_date": null
       }
    }

...

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

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

Versions Compared

Old Version 27

New Version 28

Key