Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

GET conax_web_services/provisioning_requests/show

This method returns information related with a conax web services provisioning request. A single conax web services provisioning requests is returned by each call

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

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

...

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

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

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 2,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "smartcard_ca_id": "2222",
                   "id": "2"
               },
               {
                   "service_ca_id": "1111",
                   "id": "1"
               },
               {
                   "sub_provisioning_distribution_id": "0FBD747C2FCD1D64D9DE7610C0124E0E",
                   "id": "3"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-04T10:32:45",
               "created_date": "2014-03-04T10:32:45",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "81F2271B9CFFA72D16DB4D2467FAC617",
           "process_name": null,
           "executed_date": null
       }
    }

GET conax_web_services/provisioning_requests/list

This method returns information related with notifications. Multiple notifications are returned by each call.

Resource URL

Parameters

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

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

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 2,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "0FBD747C2FCD1D64D9DE7610C0124E0E",
                   "id": "3"
               },
               {
                   "smartcard_ca_id": "2222",
                   "id": "2"
               },
               {
                   "service_ca_id": "1111",
                   "id": "1"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-04T10:32:45",
               "created_date": "2014-03-04T10:32:45",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "81F2271B9CFFA72D16DB4D2467FAC617",
           "process_name": null,
           "executed_date": null
       },
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 4,
           "name": null,
           "process_id": null,
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-06T17:31:16",
               "created_date": "2014-03-06T17:31:16",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "50B41C776BAE7E99CD0E0AE6480B3F2D",
           "process_name": null,
           "executed_date": null
       },
       {
           "scheduled_date": "2014-09-23T08:23:24",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "display_date_time": "2014-09-23T08:23:09",
                   "id": "B74051B35E46B7E7AFBB89D454EA2389"
               },
               {
                   "position_y": null,
                   "id": "64D43E4F5EB88DBBF01B2BA5A61F26D4"
               },
               {
                   "position_x": null,
                   "id": "E53BC60EFA761B27D764B03A4A29CA1E"
               },
               {
                   "smartcard_ca_id": null,
                   "id": "9E5C33963C780F3FE2DDE0DD3C929126"
               },
               {
                   "height": null,
                   "id": "99663D076D3BE412540D5C6225A34E29"
               },
               {
                   "display_duration": null,
                   "id": "0C512B9662481C5A1AF0A53D1C1BFEA4"
               },
               {
                   "fingerprint_slot": "A",
                   "id": "CC6DD4AF4F009AD6F71C252F3BC3E78D"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-09-23T08:23:32",
               "created_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-09-23T08:23:32",
               "updated_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "DISPLAY_FINGERPRINT",
           "id": "BC05D99430116586FB444BF818C89D59",
           "process_name": null,
           "executed_date": null
       },
.....
    }
   ]
}

POST conax_web_services/provisioning_request/add_subscriptions

This method is creating add subscriptions provisioning requests in a pending life cycle state, by specifying the service and the smartcard that should be activated, 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)

...

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

...

service_identifier

(mandatory)

...

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

...

smartcard_identifier

(mandatory)

...

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)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

User Defined Field of type Date

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": "04FFBB37FED475A778F122709CBAC1D5",
    "subscription_identifier":{"id":"98D375E905CD31F4CC780342525B2078"},
    "smartcard_identifier": {"id":"ABE63350738749C47F404687DA5E5A47"},      
    "service_identifier":{"id":"5C2DCFDD743632AC57AE8147B6EE665E"}, 
    "scheduled_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
       }
    }

POST conax_web_services/provisioning_request/cancel_subscriptions

This method is creating cancel subscriptions provisioning requests in a pending life cycle state, by specifying the service 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)

...

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

...

service_identifier

(mandatory)

...

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

...

smartcard_identifier

(mandatory)

...

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)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

User Defined Field of type Date

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": "04FFBB37FED475A778F122709CBAC1D5",
    "subscription_identifier":{"id":"98D375E905CD31F4CC780342525B2078"},
    "service_identifier":{"id":"5C2DCFDD743632AC57AE8147B6EE665E"},
    "smartcard_identifier":{"id":"ABE63350738749C47F404687DA5E5A47"},
    "scheduled_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
       }
    }

POST conax_web_services/provisioning_request/create_pairing

This method is creating create pairing provisioning requests in a pending life cycle state, by specifying a set of smartcards and STBs that should be paired.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(optional)

...

The subscription that the pairing might belongs to. The available subscription identifier fields are the following:

...

process_immediately

(optional)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

Tip
Available from CRM.COM R4.0.0

Table of Contents

maxLevel	2

GET conax_web_services/provisioning_requests/show

This method returns information related with a conax web services provisioning request. A single conax web services provisioning requests is returned by each call

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 2,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "smartcard_ca_id": "2222",
                   "id": "2"
               },
               {
                   "service_ca_id": "1111",
                   "id": "1"
               },
               {
                   "sub_provisioning_distribution_id": "0FBD747C2FCD1D64D9DE7610C0124E0E",
                   "id": "3"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-04T10:32:45",
               "created_date": "2014-03-04T10:32:45",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "81F2271B9CFFA72D16DB4D2467FAC617",
           "process_name": null,
           "executed_date": null
       }
    }

GET conax_web_services/provisioning_requests/list

This method returns information related with notifications. Multiple notifications are returned by each call.

Resource URL

Parameters

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

Restrictions

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

Response Data

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

{
   "status":
   {
       "message": null,
       "description": null,
       "code": "OK"
   },
   "data":
   [
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 2,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "sub_provisioning_distribution_id": "0FBD747C2FCD1D64D9DE7610C0124E0E",
                   "id": "3"
               },
               {
                   "smartcard_ca_id": "2222",
                   "id": "2"
               },
               {
                   "service_ca_id": "1111",
                   "id": "1"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-04T10:32:45",
               "created_date": "2014-03-04T10:32:45",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "81F2271B9CFFA72D16DB4D2467FAC617",
           "process_name": null,
           "executed_date": null
       },
       {
           "scheduled_date": "2014-03-04T10:32:45",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": 4,
           "name": null,
           "process_id": null,
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-03-06T17:31:16",
               "created_date": "2014-03-06T17:31:16",
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "ADD_SUBSCRIPTIONS",
           "id": "50B41C776BAE7E99CD0E0AE6480B3F2D",
           "process_name": null,
           "executed_date": null
       },
       {
           "scheduled_date": "2014-09-23T08:23:24",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "display_date_time": "2014-09-23T08:23:09",
                   "id": "B74051B35E46B7E7AFBB89D454EA2389"
               },
               {
                   "position_y": null,
                   "id": "64D43E4F5EB88DBBF01B2BA5A61F26D4"
               },
               {
                   "position_x": null,
                   "id": "E53BC60EFA761B27D764B03A4A29CA1E"
               },
               {
                   "smartcard_ca_id": null,
                   "id": "9E5C33963C780F3FE2DDE0DD3C929126"
               },
               {
                   "height": null,
                   "id": "99663D076D3BE412540D5C6225A34E29"
               },
               {
                   "display_duration": null,
                   "id": "0C512B9662481C5A1AF0A53D1C1BFEA4"
               },
               {
                   "fingerprint_slot": "A",
                   "id": "CC6DD4AF4F009AD6F71C252F3BC3E78D"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-09-23T08:23:32",
               "created_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_date": "2014-09-23T08:23:32",
               "updated_by_unit":
               {
                   "group_name": null,
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               },
               "updated_by_user":
               {
                   "person_name": "MPAdministrator",
                   "username": "MPAdministrator",
                   "id": "1",
                   "email": null
               }
           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "DISPLAY_FINGERPRINT",
           "id": "BC05D99430116586FB444BF818C89D59",
           "process_name": null,
           "executed_date": null
       },
.....
    }
   ]
}

POST conax_web_services/provisioning_request/add_subscriptions

This method is creating add subscriptions provisioning requests in a pending life cycle state, by specifying the service and the smartcard that should be activated, 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 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

scheduled_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

Restrictions

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

Response Data

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

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"}, 
    "scheduled_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
       }
    }

POST conax_web_services/provisioning_request/cancel_subscriptions

This method is creating cancel subscriptions provisioning requests in a pending life cycle state, by specifying the service 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:

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

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

Restrictions

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

Response Data

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

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"},
    "scheduled_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
       }
    }

POST conax_web_services/provisioning_request/create_pairing

This method is creating create pairing provisioning requests in a pending life cycle state, by specifying a set of smartcards and STBs 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:

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

POST conax_web_services/provisioning_request/add_to_existing_pairing

This method is creating add to existing pairing provisioning requests in a pending life cycle state, by specifying the smartcard of the existing pairing and a set of smartcards and STBs that should be added to the existing pairing

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(optional)

...

The subscription that the pairing might belongs to. The available subscription identifier fields are the following:

...

smartcard_ca_id

(mandatory)

...

The smartcard CA ID that identifies the existing pairing

...

process_immediately

(optional)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

           },
           "provider_error_code": null,
           "life_cycle_state": "PENDING",
           "provider_error_description": null,
           "type": "CREATE_PAIRING",
           "id": "F63207AD7773D74AB96E414AEE8B6F66",
           "process_name": null,
           "executed_date": null
       }
    }

POST conax_web_services/provisioning_request/add_to_existing_pairing

This method is creating add to existing pairing provisioning requests in a pending life cycle state, by specifying the smartcard of the existing pairing and a set of smartcards and STBs that should be added to the existing pairing

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:

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

(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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
      "token": "B1D195F4D5C35435F1B1215521E1098B",
      "smartcard_ca_id":"0000-0000-0008",       
      "stb_set": [{"stb_ca_id":"0000-0000-0007"}]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2014-10-15T13:53:12",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "existing_smartcard_ca_id": "0000-0000-0008",
                   "id": "8F36244F78FDCF90A96B2F2504132495"
               },
               {
                   "id": "6ED43647157F14D218F81C9B9A61033B",
                   "stb_ca_id": "0000-0000-0007"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2014-10-15T13:53:12",
               "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-15T13:53:12",
               "updated_by_unit":
               {
                   "community_name": "Main Community",
                   "group_name": "Main Group",
                   "name": "Admin Unit",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "description": "r1",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {,
                   "group_name": "Main Group",
                   "person_name": "MariosAdmin LannisterUnit",
                   "usernameid": "MPAdministrator48305F8849E3C18B227C5BE3A27BA6DF",
                   "iddescription": "1r1",
                   "emailalternative_code": null"MG"
               },
               "updatedcreated_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_TO_EXISTING_PAIRING",
           "id": "D2A0EF48E0A7FD61E90C026940715C3E",
           "process_name": "MANUAL",
           "executed_date": null
       }
    }

POST conax_web_services/provisioning_request/reset_pin_to_default_value

This method is creating reset pin 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)

...

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)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

               "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_TO_EXISTING_PAIRING",
           "id": "D2A0EF48E0A7FD61E90C026940715C3E",
           "process_name": "MANUAL",
           "executed_date": null
       }
    }

POST conax_web_services/provisioning_request/reset_pin_to_default_value

This method is creating reset pin 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:

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

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

Restrictions

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

...

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_error_code": null,
           "executedlife_cycle_datestate": null"PENDING",
       }     }

POST conax_web_services/provisioning_request/reset_pin_to_given_value

This method is creating reset 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)

...

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)

...

scheduled_date

(optional)

...

priority

(optional)

...

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

REGULAR
EXPRESS

If not specified then it is set to REGULAR

...

udf_string_1

(optional)

...

udf_string_2

(optional)

...

User Defined Field of type String

...

udf_string_3

(optional)

...

User Defined Field of type String

...

udf_string_4

(optional)

...

User Defined Field of type String

...

udf_string_5

(optional)

...

User Defined Field of type String

...

udf_string_6

(optional)

...

User Defined Field of type String

...

udf_string_7

(optional)

...

User Defined Field of type String

...

udf_string_8

(optional)

...

User Defined Field of type String

...

udf_float_1

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_2

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_3

(optional)

...

Float

...

User Defined Field of type Float

...

udf_float_4

(optional)

...

Float

...

User Defined Field of type Float

...

udf_date_1

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_2

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_3

(optional)

...

Date

...

User Defined Field of type Date

...

udf_date_4

(optional)

...

Date

...

"provider_error_description": null,
           "type": "UPDATE_CA_PIN_TO_DEFAULT_VALUE",
           "id": "DD59BBD1F02E929243C952E8B56733DC",
           "process_name": null,
           "executed_date": null
       }
    }

POST conax_web_services/provisioning_request/reset_pin_to_given_value

This method is creating reset 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

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

Restrictions

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

...

Page Comparison

Versions Compared

Old Version 25

New Version 26

Key

GET conax_web_services/provisioning_requests/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET conax_web_services/provisioning_requests/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/create_pairing

Resource URL

Parameters

GET conax_web_services/provisioning_requests/show

Resource URL

Parameters

Restrictions

Response Data

Examples

GET conax_web_services/provisioning_requests/list

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/create_pairing

Resource URL

Parameters

POST conax_web_services/provisioning_request/add_to_existing_pairing

Resource URL

Parameters

POST conax_web_services/provisioning_request/add_to_existing_pairing

Resource URL

Parameters

POST conax_web_services/provisioning_request/reset_pin_to_default_value

Resource URL

Parameters

POST conax_web_services/provisioning_request/reset_pin_to_default_value

Resource URL

Parameters

Restrictions

POST conax_web_services/provisioning_request/reset_pin_to_given_value

Resource URL

Parameters

POST conax_web_services/provisioning_request/reset_pin_to_given_value

Resource URL

Parameters

Restrictions