Tip
Available from CRM.COM R8.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

provisioning_request_identifier

(semi-optional)

Provisioning Request identifier

The identifier of the provisioning request that should be returned as a result. The allowed provisioning request identifier fields are the following:

Include Page

	V4:provisioning_request_identifier
	V4:provisioning_request_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name	Type	Description
token	String	The token retrieved from the login method
type (semi-optional)	String	The type of the provisioning request to be retrieved. The supported types are the following: ADD_SUBSCRIPTIONS CANCEL_SUBSCRIPTIONS 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

...

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

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

...

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

{
	"token"			: "03B1C25A82B14478BF681FA6F7ADD815",
	"subscription_identifier" : { "number" : "S60149" },
	"service_identifier" : { "code" : "Silver" },
	"smartcard_identifier" : { "serial_number" : "smrt20000055" }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-10-29T09:51:50",
           "response": null,
           "error_code": null,
           "priority": null,
           "error_description": null,
           "sequence_number": 1,
           "number": "18857",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "service_ca_id": "9",
                   "id": "F049A0965D6E4E74B6FAE0826FA1BAAE"
               },
               {
                   "smartcard_ca_id": "smrt20000055",
                   "id": "F120B139CD4C4EBC95AE5D52D9B24F4B"
               },
               {
                   "sub_provisioning_distribution_id": "B4AE85FCFA8C4329A2C6F767B879E070",
                   "id": "C35201BD841E4B9DB1847F08527CF241"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-10-29T09:51:50",
               "created_date": "2015-10-29T09:51:50",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "life_cycle_state": "PENDING",
           "type": "ADD_SUBSCRIPTIONS",
           "process_name": null,
           "id": "D8E447B94E5F4B6886C6FB7C1B5ADFC8",
           "reference_number": null,
           "executed_date": null
       }
}

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

service_identifier

(mandatory)

Product identifier

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

Include Page

	V4:product_identifier
	V4:product_identifier

smartcard_identifier

(mandatory)

Installed Item identifier

The smartcard that the service should be added on. Only installed items classified as smartcards through the provisioning provider can be specified. The available installed item identifier fields are the following:

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token"			: "03B1C25A82B14478BF681FA6F7ADD815",
	"subscription_identifier" : { "number" : "S60149" },
	"service_identifier" : { "code" : "Silver" },
	"smartcard_identifier" : { "serial_number" : "smrt20000055" }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

    {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-10-29T09:5155:5026",
           "response": null,
           "error_code": null,
           "priority": null,
           "error_description": null,
           "sequence_number": 1,
           "number": "1885718858",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "servicesub_provisioning_cadistribution_id": "9B4AE85FCFA8C4329A2C6F767B879E070",
                   "id": "F049A0965D6E4E74B6FAE0826FA1BAAEC10E5761AD014428B217C36494F381F9"
               },
               {
                   "smartcardservice_ca_id": "smrt200000559",
                   "id": "F120B139CD4C4EBC95AE5D52D9B24F4B49BEA99FE3CA4D02A3E819C4EF52D0D8"
               },
               {
                   "subsmartcard_provisioningca_distribution_id": "B4AE85FCFA8C4329A2C6F767B879E070smrt20000055",
                   "id": "C35201BD841E4B9DB1847F08527CF241D43774D744444D8AA8E47192008BC359"
               }
           ],
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-10-29T09:5155:5026",
               "created_date": "2015-10-29T09:5155:5026",
               "created_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "updated_by_unit":
               {
                   "community_name": "Internal Community",
                   "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                   "name": "Admin Unit",
                   "group_name": "Main Group",
                   "description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
                   "alternative_code": "MG"
               },
               "created_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               },
               "updated_by_user":
               {
                   "person_name": "Marios Lannister",
                   "username": "MPAdministrator",
                   "id": "1"
               }
           },
           "life_cycle_state": "PENDING",
           "type": "ADDCANCEL_SUBSCRIPTIONS",
           "process_name": null,
           "id": "D8E447B94E5F4B6886C6FB7C1B5ADFC8DD3B2596CFB94C928375209659842F21",
           "reference_number": null,
           "executed_date": null
       }
}
      }

POST conax_web_services/provisioning_requests/create_pairing

...

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

...

Versions Compared

Old Version 4

New Version 5

Key

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

POST conax_web_services/provisioning_requests/create_pairing

Page Comparison

Versions Compared

Old Version 4

New Version 5

Key

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

POST conax_web_services/provisioning_requests/create_pairing