Available from CRM.COM R8.0.0

GET conax_sms_sas/provisioning_requests/show

This method returns information related with a Conax SMS-SAS Interface provisioning request. A single Conax SMS-SAS Interface provisioning request 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:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning request

number

(semi-optional)

String

The number of the provisioning 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

Name	Type	Description
id	String	The ID of the retrieved provisioning request
number	String	The number of the retrieved provisioning request
type	String	A code that uniquely identifies the type of provisioning request that is performed. The supported options 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
sequence_number	String	The sequence number of the retrieved provisioning request
scheduled_date	Date	The date that the provisioning request is scheduled to be send
executed_date	Date	The date that the provisioning request was actually send
priority	String	The priority of the provisioning request. The supported values are the following: REGULAR EXPRESS
life_cycle_state	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
request	String	The actual request that was send to Conax
response	String	The actual response that was received from Conax
reference_number	String	A reference number provided by Conax after receiving the request
error_code	String	The error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_description	String	The error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_name	String	The name of the process that submitted the provisioning request, which can be one of the following: PROVISIONING_REQUEST_PROCESSING MAIL_BARK_MESSAGE_UTILITY PAIRING_UTILITY FIINGERPRINTING_UTILITY RESET_PIN MANUAL
process_id	String	The ID of the process that submitted the provisioning request
log_information	Log Information Object	The log information related with the retrieved provisioning request
parameters_set	Set of Conax Web Services Provisioning Request Item objects	The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

conax web services provisioning request item response data

Name	Type	Description
id	String	The ID of the retrieved provisioning request item
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
service_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_id	String	The smartcard CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_id	String	The STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request

sub_provisioning_distribution_id	String
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
smartcard_sub_provisioning_distribution_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
smartcard_ca_id	String
stb_sub_provisioning_distributor_id	String
stb_ca_id	String
existing_smartcard_sub_provisioning_distributor_id	String
existing_smartcard_ca_id	String
ca_pin	Integer
display_date_time	Date
display_duration	Integer
position_x	Integer
position_y	Integer
height	Integer
fingerprint_slot	String
message	String
star_indication_date_time	Date
communication_queue_id	String
repetition_count	Integer
repetition_interval	Integer

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET conax_sms_sas/provisioning_requests/list

This method returns information related with Conax SMS-SAS Interface provisioning requests. Multiple Conax SMS-SAS Interface provisioning requests 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 RENEW_SUBSCRIPTIONS CREATE_PAIRING
life_cycle_state (semi-optional)	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
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

Name	Type	Description
id	String	The ID of the retrieved provisioning request
number	String	The number of the retrieved provisioning request
type	String	A code that uniquely identifies the type of provisioning request that is performed. The supported options 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
sequence_number	String	The sequence number of the retrieved provisioning request
scheduled_date	Date	The date that the provisioning request is scheduled to be send
executed_date	Date	The date that the provisioning request was actually send
priority	String	The priority of the provisioning request. The supported values are the following: REGULAR EXPRESS
life_cycle_state	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
request	String	The actual request that was send to Conax
response	String	The actual response that was received from Conax
reference_number	String	A reference number provided by Conax after receiving the request
error_code	String	The error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_description	String	The error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_name	String	The name of the process that submitted the provisioning request, which can be one of the following: PROVISIONING_REQUEST_PROCESSING MAIL_BARK_MESSAGE_UTILITY PAIRING_UTILITY FIINGERPRINTING_UTILITY RESET_PIN MANUAL
process_id	String	The ID of the process that submitted the provisioning request
log_information	Log Information Object	The log information related with the retrieved provisioning request
parameters_set	Set of Conax Web Services Provisioning Request Item objects	The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

conax web services provisioning request item response data

Name	Type	Description
id	String	The ID of the retrieved provisioning request item
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
service_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_id	String	The smartcard CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_id	String	The STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request

sub_provisioning_distribution_id	String
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
smartcard_sub_provisioning_distribution_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
smartcard_ca_id	String
stb_sub_provisioning_distributor_id	String
stb_ca_id	String
existing_smartcard_sub_provisioning_distributor_id	String
existing_smartcard_ca_id	String
ca_pin	Integer
display_date_time	Date
display_duration	Integer
position_x	Integer
position_y	Integer
height	Integer
fingerprint_slot	String
message	String
star_indication_date_time	Date
communication_queue_id	String
repetition_count	Integer
repetition_interval	Integer

Examples

Example 1

HTTP Method: GET

Request:

Response:

POST conax_sms_sas/provisioning_requests/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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

start_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

Restrictions

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved provisioning request
number	String	The number of the retrieved provisioning request
type	String	A code that uniquely identifies the type of provisioning request that is performed. The supported options 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
sequence_number	String	The sequence number of the retrieved provisioning request
scheduled_date	Date	The date that the provisioning request is scheduled to be send
executed_date	Date	The date that the provisioning request was actually send
priority	String	The priority of the provisioning request. The supported values are the following: REGULAR EXPRESS
life_cycle_state	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
request	String	The actual request that was send to Conax
response	String	The actual response that was received from Conax
reference_number	String	A reference number provided by Conax after receiving the request
error_code	String	The error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_description	String	The error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_name	String	The name of the process that submitted the provisioning request, which can be one of the following: PROVISIONING_REQUEST_PROCESSING MAIL_BARK_MESSAGE_UTILITY PAIRING_UTILITY FIINGERPRINTING_UTILITY RESET_PIN MANUAL
process_id	String	The ID of the process that submitted the provisioning request
log_information	Log Information Object	The log information related with the retrieved provisioning request
parameters_set	Set of Conax Web Services Provisioning Request Item objects	The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

conax web services provisioning request item response data

Name	Type	Description
id	String	The ID of the retrieved provisioning request item
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
service_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_id	String	The smartcard CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_id	String	The STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request

sub_provisioning_distribution_id	String
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
smartcard_sub_provisioning_distribution_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
smartcard_ca_id	String
stb_sub_provisioning_distributor_id	String
stb_ca_id	String
existing_smartcard_sub_provisioning_distributor_id	String
existing_smartcard_ca_id	String
ca_pin	Integer
display_date_time	Date
display_duration	Integer
position_x	Integer
position_y	Integer
height	Integer
fingerprint_slot	String
message	String
star_indication_date_time	Date
communication_queue_id	String
repetition_count	Integer
repetition_interval	Integer

Examples

Example 1

HTTP Method: POST

Request:

Body:

Response:

POST conax_sms_sas/provisioning_requests/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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the installed item

serial_number

(semi-optional)

String

The serial number of the installed item

alternative_code

(semi-optional)

String

The alternative code of a installed item

start_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

Restrictions

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved provisioning request
number	String	The number of the retrieved provisioning request
type	String	A code that uniquely identifies the type of provisioning request that is performed. The supported options 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
sequence_number	String	The sequence number of the retrieved provisioning request
scheduled_date	Date	The date that the provisioning request is scheduled to be send
executed_date	Date	The date that the provisioning request was actually send
priority	String	The priority of the provisioning request. The supported values are the following: REGULAR EXPRESS
life_cycle_state	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
request	String	The actual request that was send to Conax
response	String	The actual response that was received from Conax
reference_number	String	A reference number provided by Conax after receiving the request
error_code	String	The error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_description	String	The error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_name	String	The name of the process that submitted the provisioning request, which can be one of the following: PROVISIONING_REQUEST_PROCESSING MAIL_BARK_MESSAGE_UTILITY PAIRING_UTILITY FIINGERPRINTING_UTILITY RESET_PIN MANUAL
process_id	String	The ID of the process that submitted the provisioning request
log_information	Log Information Object	The log information related with the retrieved provisioning request
parameters_set	Set of Conax Web Services Provisioning Request Item objects	The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

conax web services provisioning request item response data

Name	Type	Description
id	String	The ID of the retrieved provisioning request item
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
service_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_id	String	The smartcard CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_id	String	The STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request

sub_provisioning_distribution_id	String
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
smartcard_sub_provisioning_distribution_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
smartcard_ca_id	String
stb_sub_provisioning_distributor_id	String
stb_ca_id	String
existing_smartcard_sub_provisioning_distributor_id	String
existing_smartcard_ca_id	String
ca_pin	Integer
display_date_time	Date
display_duration	Integer
position_x	Integer
position_y	Integer
height	Integer
fingerprint_slot	String
message	String
star_indication_date_time	Date
communication_queue_id	String
repetition_count	Integer
repetition_interval	Integer

Examples

Example 1

HTTP Method: POST

Request:

Body:

Response:

POST conax_web_services/provisioning_requests/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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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

Referred Objects Response Data

conax_web services smartcard parameters

Name

Type

Description

smartcard_ca_id

(mandatory)

String

The CA ID of the smartcard

conax_web services smartcard parameters

Name

Type

Description

stb_ca_id

(mandatory)

String

The CA ID of the STB

Restrictions

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

Response Data

Name	Type	Description
id	String	The ID of the retrieved provisioning request
number	String	The number of the retrieved provisioning request
type	String	A code that uniquely identifies the type of provisioning request that is performed. The supported options 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
sequence_number	String	The sequence number of the retrieved provisioning request
scheduled_date	Date	The date that the provisioning request is scheduled to be send
executed_date	Date	The date that the provisioning request was actually send
priority	String	The priority of the provisioning request. The supported values are the following: REGULAR EXPRESS
life_cycle_state	String	The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
request	String	The actual request that was send to Conax
response	String	The actual response that was received from Conax
reference_number	String	A reference number provided by Conax after receiving the request
error_code	String	The error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_description	String	The error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_name	String	The name of the process that submitted the provisioning request, which can be one of the following: PROVISIONING_REQUEST_PROCESSING MAIL_BARK_MESSAGE_UTILITY PAIRING_UTILITY FIINGERPRINTING_UTILITY RESET_PIN MANUAL
process_id	String	The ID of the process that submitted the provisioning request
log_information	Log Information Object	The log information related with the retrieved provisioning request
parameters_set	Set of Conax Web Services Provisioning Request Item objects	The parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

conax web services provisioning request item response data

Name	Type	Description
id	String	The ID of the retrieved provisioning request item
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
service_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_id	String	The smartcard CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_id	String	The STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_id	String	The ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request

sub_provisioning_distribution_id	String
service_ca_id	String	The subscription service CA ID that will be affected by the provisioning request
smartcard_sub_provisioning_distribution_id	String	The ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
smartcard_ca_id	String
stb_sub_provisioning_distributor_id	String
stb_ca_id	String
existing_smartcard_sub_provisioning_distributor_id	String
existing_smartcard_ca_id	String
ca_pin	Integer
display_date_time	Date
display_duration	Integer
position_x	Integer
position_y	Integer
height	Integer
fingerprint_slot	String
message	String
star_indication_date_time	Date
communication_queue_id	String
repetition_count	Integer
repetition_interval	Integer

Examples

Example 1

HTTP Method: POST

Request:

Body:

Response: