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

...

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

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

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

provisioningrequestprovisioning_request_identifierfields_setA list of fields that should be included in the results 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

scheduled_date

(optional)

List of Strings, comma separated

String

The date that the provisioning request will be appied. If not specified then

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

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 returnedit 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
udf_string_1 (optional)	String	User Defined Field of type String
udf_string_2 (optional)	String	User Defined Field of type String
udf_string_3 (optional)	String	User Defined Field of type String
udf_string_4 (optional)	String	User Defined Field of type String
udf_string_5 (optional)	String	User Defined Field of type String
udf_string_6 (optional)	String	User Defined Field of type String
udf_string_7 (optional)	String	User Defined Field of type String
udf_string_8 (optional)	String	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

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

HTTP Method: GET

Request:

Expand

title	Example 1

1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Response:

Code Block

theme	Confluence
language	jsjavascript
linenumbers	true

POST conax_web_services/provisioning_request/

...

cancel_subscriptions

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

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST conax_web_services/provisioning_request/

...

create_

...

pairing

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

...

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:installed_itemsubscription_identifier
	V4:installed_itemsubscription_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

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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 DateField of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

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

Anchor

	add pairing provisioning request objects
	add pairing provisioning request objects

Referred Objects Response Data

Include Page

	V4:conax_web_services_smartcard_parameters
	V4:conax_web_services_smartcard_parameters

Include Page

	V4:conax_web_services_stb_parameters
	V4:conax_web_services_stb_parameters

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

POST conax_web_services/provisioning_request/

...

POST conax_web_services/provisioning_request/add_to_existing_pairing

This method is creating reset pin to given value add to existing pairing 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.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

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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

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

Anchor

	add pairing provisioning request objects
	add pairing provisioning request objects

Referred Objects Response Data

Include Page

	V4:conax_web_services_smartcard_parameters
	V4:conax_web_services_smartcard_parameters

Include Page

	V4:conax_web_services_stb_parameters
	V4:conax_web_services_stb_parameters

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

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

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

...

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

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

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

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

Page Comparison

Versions Compared

Old Version 7

New Version 8

Key

GET conax_web_services/provisioning_requests/show

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

GET conax_web_services/provisioning_requests/list

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

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_request/

POST conax_web_services/provisioning_request/add_to_existing_pairing

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples

Resource URL

Parameters

Restrictions

Response Data

Examples