You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
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: 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: |
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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_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
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: |
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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_web_services/provisioning_request/add_subscriptions
This method creates an activity. Single activities can be created by each call. Only customer activities can be created through this method.
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| | Date | The date that the provisioning request is scheduled to be send |
priority (optional) | String | The priority of the provisioning request. The supported values are the following: |
subscription_identifier (mandatory) | Subscription identifier | The type of the activity. The allowed activity type identifiers are the following: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the activity type | name (semi-optional) | String | The code of the activity type | alternative_code (semi-optional) | String | The alternative code of the activity type |
|
service_identifier (mandatory) | Service identifier | |
smartcard_identifier (mandatory) | Smartcard identifier | |
| | | |
| | | |
| | | |
| | | |
| | | |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_3 (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
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: |
| 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 |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
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_request/cancel_subscriptions
POST conax_web_services/provisioning_request/create_pairing
POST conax_web_services/provisioning_request/add_to_existing_pairing
POST conax_web_services/provisioning_request/reset_pin_to_default_value
POST conax_web_services/provisioning_request/reset_pin_to_given_value