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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "scheduled_date": "2014-08-08T00:00:00",
    "response": null,
    "error_code": "AxisFault",
    "priority": "REGULAR",
    "error_description": "AxisFault\n faultCode: not_logged_in\n faultSubcode: \n faultString: txt_not_logged_in\n faultActor: \n faultNode: \n faultDetail: \n\t{http://xml.apache.org/axis/}stackTrace:txt_not_logged_in\n\tat org.apache.axis.message.SOAPFaultBuilder.createFault(SOAPFaultBuilder.java:222)\n\tat org.apache.axis.message.SOAPFaultBuilder.endElement(SOAPFaultBuilder.java:129)\n\tat org.apache.axis.encoding.DeserializationContext.endElement(DeserializationContext.java:1087)\n\tat org.apache.xerces.parsers.AbstractSAXParser.endElement(Unknown Source)\n\tat org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanEndElement(Unknown Source)\n\tat org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContentDispatcher.dispatch(Unknown Source)\n\tat org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanDocument(Unknown Source)\n\tat org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)\n\tat org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)\n\tat org.apache.xerces.parsers.XMLParser.parse(Unknown Source)\n\tat org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source)\n\tat org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown Source)\n\tat org.apache.xerces.jaxp.SAXParserImpl.parse(Unknown Source)\n\tat org.apache.axis.encoding.DeserializationContext.parse(DeserializationContext.java:227)\n\tat org.apache.axis.SOAPPart.getAsSOAPEnvelope(SOAPPart.java:696)\n\tat org.apache.axis.Message.getSOAPEnvelope(Message.java:435)\n\tat org.apache.axis.handlers.soap.MustUnderstandChecker.invoke(MustUnderstandChecker.java:62)\n\tat org.apache.axis.client.AxisClient.invoke(AxisClient.java:206)\n\tat org.apache.axis.client.Call.invokeEngine(Call.java:2784)\n\tat org.apache.axis.client.Call.invoke(Call.java:2767)\n\tat org.apache.axis.client.Call.invoke(Call.java:2443)\n\tat org.apache.axis.client.Call.invoke(Call.java:2366)\n\tat org.apache.axis.client.Call.invoke(Call.java:1812)\n\tat de.panaccess.cableview.wsdl.v4_0.operator.CableViewServiceBindingStub.cvSetSmartcardPackages(CableViewServiceBindingStub.java:5631)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceBean.processSetPackage(CRMProcessPanaccessWebServiceBean.java:487)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceBean.processProvisioningRequest(CRMProcessPanaccessWebServiceBean.java:112)\n\tat sun.reflect.GeneratedMethodAccessor441.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.EJSContainer.invokeProceed(EJSContainer.java:6304)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:568)\n\tat com.crm.beans.CRMInterceptor.logCall(CRMInterceptor.java:100)\n\tat sun.reflect.GeneratedMethodAccessor158.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.interceptors.InterceptorProxy.invokeInterceptor(InterceptorProxy.java:227)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:548)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.doAroundInvoke(InvocationContextImpl.java:229)\n\tat com.ibm.ejs.container.EJSContainer.invoke(EJSContainer.java:6195)\n\tat com.crm.process.provisioning.panaccess.EJSLocalNSLCRMProcessPanaccessWebServiceBea_34cd4535.processProvisioningRequest(EJSLocalNSLCRMProcessPanaccessWebServiceBea_34cd4535.java)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceProcessRunBean.processProvisioningRequest(CRMProcessPanaccessWebServiceProcessRunBean.java:1085)\n\tat sun.reflect.GeneratedMethodAccessor439.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.crm.framework.util.ReflectionUtil.invoke(ReflectionUtil.java:304)\n\tat com.crm.businessobject.CRMBase.dispatch(CRMBase.java:877)\n\tat com.crm.businessobject.CRMBase.invoke(CRMBase.java:791)\n\tat sun.reflect.GeneratedMethodAccessor434.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.EJSContainer.invokeProceed(EJSContainer.java:6304)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:568)\n\tat com.crm.beans.CRMInterceptor.logCall(CRMInterceptor.java:148)\n\tat sun.reflect.GeneratedMethodAccessor158.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.interceptors.InterceptorProxy.invokeInterceptor(InterceptorProxy.java:227)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:548)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.doAroundInvoke(InvocationContextImpl.java:229)\n\tat com.ibm.ejs.container.EJSContainer.invoke(EJSContainer.java:6195)\n\tat com.crm.process.provisioning.panaccess.EJSLocalNSLCRMProcessPanaccessWebServicePro_098a6ea1.invoke(EJSLocalNSLCRMProcessPanaccessWebServicePro_098a6ea1.java)\n\tat sun.reflect.GeneratedMethodAccessor433.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.crm.framework.util.ReflectionUtil.invoke(ReflectionUtil.java:304)\n\tat com.crm.beans.BeanUtil.dispatch(BeanUtil.java:228)\n\tat com.crm.beans.BeanUtil.dispatch(BeanUtil.java:177)\n\tat com.crm.beans.CRMThread.run(CRMThread.java:54)\n\n\t{http://xml.apache.org/axis/}hostname:cyn1lnx002\n\ntxt_not_logged_in\n\tat org.apache.axis.message.SOAPFaultBuilder.createFault(SOAPFaultBuilder.java:222)\n\tat org.apache.axis.message.SOAPFaultBuilder.endElement(SOAPFaultBuilder.java:129)\n\tat org.apache.axis.encoding.DeserializationContext.endElement(DeserializationContext.java:1087)\n\tat org.apache.xerces.parsers.AbstractSAXParser.endElement(Unknown Source)\n\tat org.apache.xerces.impl.XMLNSDocumentScannerImpl.scanEndElement(Unknown Source)\n\tat org.apache.xerces.impl.XMLDocumentFragmentScannerImpl$FragmentContentDispatcher.dispatch(Unknown Source)\n\tat org.apache.xerces.impl.XMLDocumentFragmentScannerImpl.scanDocument(Unknown Source)\n\tat org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)\n\tat org.apache.xerces.parsers.XML11Configuration.parse(Unknown Source)\n\tat org.apache.xerces.parsers.XMLParser.parse(Unknown Source)\n\tat org.apache.xerces.parsers.AbstractSAXParser.parse(Unknown Source)\n\tat org.apache.xerces.jaxp.SAXParserImpl$JAXPSAXParser.parse(Unknown Source)\n\tat org.apache.xerces.jaxp.SAXParserImpl.parse(Unknown Source)\n\tat org.apache.axis.encoding.DeserializationContext.parse(DeserializationContext.java:227)\n\tat org.apache.axis.SOAPPart.getAsSOAPEnvelope(SOAPPart.java:696)\n\tat org.apache.axis.Message.getSOAPEnvelope(Message.java:435)\n\tat org.apache.axis.handlers.soap.MustUnderstandChecker.invoke(MustUnderstandChecker.java:62)\n\tat org.apache.axis.client.AxisClient.invoke(AxisClient.java:206)\n\tat org.apache.axis.client.Call.invokeEngine(Call.java:2784)\n\tat org.apache.axis.client.Call.invoke(Call.java:2767)\n\tat org.apache.axis.client.Call.invoke(Call.java:2443)\n\tat org.apache.axis.client.Call.invoke(Call.java:2366)\n\tat org.apache.axis.client.Call.invoke(Call.java:1812)\n\tat de.panaccess.cableview.wsdl.v4_0.operator.CableViewServiceBindingStub.cvSetSmartcardPackages(CableViewServiceBindingStub.java:5631)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceBean.processSetPackage(CRMProcessPanaccessWebServiceBean.java:487)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceBean.processProvisioningRequest(CRMProcessPanaccessWebServiceBean.java:112)\n\tat sun.reflect.GeneratedMethodAccessor441.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.EJSContainer.invokeProceed(EJSContainer.java:6304)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:568)\n\tat com.crm.beans.CRMInterceptor.logCall(CRMInterceptor.java:100)\n\tat sun.reflect.GeneratedMethodAccessor158.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.interceptors.InterceptorProxy.invokeInterceptor(InterceptorProxy.java:227)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:548)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.doAroundInvoke(InvocationContextImpl.java:229)\n\tat com.ibm.ejs.container.EJSContainer.invoke(EJSContainer.java:6195)\n\tat com.crm.process.provisioning.panaccess.EJSLocalNSLCRMProcessPanaccessWebServiceBea_34cd4535.processProvisioningRequest(EJSLocalNSLCRMProcessPanaccessWebServiceBea_34cd4535.java)\n\tat com.crm.process.provisioning.panaccess.CRMProcessPanaccessWebServiceProcessRunBean.processProvisioningRequest(CRMProcessPanaccessWebServiceProcessRunBean.java:1085)\n\tat sun.reflect.GeneratedMethodAccessor439.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.crm.framework.util.ReflectionUtil.invoke(ReflectionUtil.java:304)\n\tat com.crm.businessobject.CRMBase.dispatch(CRMBase.java:877)\n\tat com.crm.businessobject.CRMBase.invoke(CRMBase.java:791)\n\tat sun.reflect.GeneratedMethodAccessor434.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.EJSContainer.invokeProceed(EJSContainer.java:6304)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:568)\n\tat com.crm.beans.CRMInterceptor.logCall(CRMInterceptor.java:148)\n\tat sun.reflect.GeneratedMethodAccessor158.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.ibm.ejs.container.interceptors.InterceptorProxy.invokeInterceptor(InterceptorProxy.java:227)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.proceed(InvocationContextImpl.java:548)\n\tat com.ibm.ejs.container.interceptors.InvocationContextImpl.doAroundInvoke(InvocationContextImpl.java:229)\n\tat com.ibm.ejs.container.EJSContainer.invoke(EJSContainer.java:6195)\n\tat com.crm.process.provisioning.panaccess.EJSLocalNSLCRMProcessPanaccessWebServicePro_098a6ea1.invoke(EJSLocalNSLCRMProcessPanaccessWebServicePro_098a6ea1.java)\n\tat sun.reflect.GeneratedMethodAccessor433.invoke(Unknown Source)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:37)\n\tat java.lang.reflect.Method.invoke(Method.java:611)\n\tat com.crm.framework.util.ReflectionUtil.invoke(ReflectionUtil.java:304)\n\tat com.crm.beans.BeanUtil.dispatch(BeanUtil.java:228)\n\tat com.crm.beans.BeanUtil.dispatch(BeanUtil.java:177)\n\tat com.crm.beans.CRMThread.run(CRMThread.java:54)\n",
    "sequence_number": null,
    "number": "4049",
    "process_id": "946A0EAA9A0EC57A387C820E006C1C6A",
    "name": null,
    "parameters_set": [
      {
        "service_ca_id": null,
        "EF8BEB3440D5E60BF961C4963D028A38id": "C5C057CEF0615770BC09153C7740D2CA"
      },
      {
        "sub_provisioning_distribution_id": "660EC70EB14FD3BB0BDF9A945436260B",
        "id": "FFA301FE73E0D3639AEB95B8FF982012"
      },
      {
        "smartcard_ca_id": "d100000000007",
        "id": "9A8D07B05C11D9403F78D4791A8D1111"
      },
      {
        "service_ca_id": null,"EF8BEB3440D5E60BF961C4963D028A38"
        "id": "C5C057CEF0615770BC09153C7740D2CA"
      }
    ],
    "process_immediately": 0,
    "request": null,
    "log_information": {
      "updated_date": "2014-11-19T13:20:52",
      "created_date": "2014-11-19T12:48:15",
      "created_by_unit": {
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "updated_by_unit": {
        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
        "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
        "alternative_code": "MG"
      },
      "created_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      },
      "updated_by_user": {
        "person_name": "MPAdministrator",
        "username": "MPAdministrator",
        "id": "1"
      }
    },
    "life_cycle_state": "REJECTED",
    "type": "SET_PACKAGE",
    "process_name": "PROVISIONING_REQUEST_PROCESSING_RUN",
    "id": "B3A0D82D1E3B0D54F288044D6D77A7FB",
    "reference_number": null,
    "executed_date": "2014-11-19T13:20:52"
  }
}

GET conax_sms_sas/provisioning_requests/list

...

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	js
linenumbers	true

 {
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": [
    {
      "scheduled_date": "20142015-1011-08T0012T14:0050:0033",
      "response": null,
      "error_code": null,
      "priority": "REGULAR"null,
      "error_description": null,
      "sequence_number": null1,
      "number": "220644",
      "process_id": "BE56839D489D3006B32E72BEA20CA9EC"null,
      "name": null,
      "parameters_set": [
        {
          "smartcardservice_ca_id": "smrt20000008300",
          "id": "0CC37A54FFE84629010EC75BCE8B5D7FC17ADC11950F4CA0B154F6E135E7158F"
        },
        {
          "servicesub_provisioning_cadistribution_id": null"EF8C13A2F07D4F55B846A52CC81A53A6",
          "id": "E70391BD324DDA2103527E5F3831896B6E03189DF64445CD81B0DD8585DFA2D6"
        },
        {
          "subsmartcard_provisioningca_distribution_id": "0B5AB1A8867CAD419BFEBB801A458FDDsc444444441",
          "id": "BEE5A6951EAA7B2BAA029B3E265052FA693382D40FA046D881DAED033DD07633"
        }
      ],
      "process_immediately": 0null,
      "request": null,
      "log_information": {
        "updated_date": "20142015-1011-08T1412T14:4450:5933",
        "created_date": "20142015-1011-08T1412T14:4450:5933",
        "created_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "life_cycle_state": "PENDING",
      "type": "ADD_SUBSCRIPTIONS",
      "id": "63344A5469D8A77313AF446EA44A27BC5BE1C8D8CD83408DBD31421061CB4862",
      "process_name": "PROVISIONING_REQUEST_PROCESSING_RUN"null,
      "reference_number": null,
      "executed_date": null
    },
    {
     ]
}

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)

...

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

...

service_identifier

(mandatory)

...

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

...

smartcard_identifier

(mandatory)

...

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

...

start_date

(optional)

...

Restrictions

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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
       "status":
       {
 "scheduled_date": "2015-11-12T14:57:35",
      "response": null,
      "error_code": null,
      "priority": null,
      "error_description": null,
      "sequence_number": 1,
      "number": "20645",
      "process_id": null,
      "name": null,
      "parameters_set": [
        {
          "sub_provisioning_distribution_id": "EF8C13A2F07D4F55B846A52CC81A53A6",
          "id": "2DB2CA484C7143ABB4C838743DA2BC20"
        },
        {
          "smartcard_ca_id": "sc444444441",
          "id": "BE2D1218CB1A4406B18720722022A2CC"
        },
        {
          "service_ca_id": "300",
          "messageid": "2C48205288394B879DD29DB7301B5AE6",
        }
  "description": "",     ],
      "codeprocess_immediately": "OK"null,
      "request": }null,

      "datalog_information": {
      {  "updated_date": "2015-11-12T14:57:35",
        "scheduledcreated_date": "2015-1011-29T0912T14:5157:5035",
  
        "responsecreated_by_unit": null,
{
          "error_codeid": null"48305F8849E3C18B227C5BE3A27BA6DF",
           "priorityname": "Admin nullUnit",

          "error_description": null"r1",
           "sequencealternative_numbercode": 1,"MG"
        },
        "numberupdated_by_unit": "18857",
{
          "process_id": null"48305F8849E3C18B227C5BE3A27BA6DF",

          "name": null"Admin Unit",
           "parameters_setdescription": "r1",
          [
"alternative_code": "MG"
        },
     {         "created_by_user": {
          "serviceperson_ca_idname": "9MPAdministrator",
          "username": "MPAdministrator",
          "id": "F049A0965D6E4E74B6FAE0826FA1BAAE1"
               },
        "updated_by_user": {
     {         "person_name": "MPAdministrator",
          "smartcard_ca_idusername": "smrt20000055MPAdministrator",
        
          "id": "F120B139CD4C4EBC95AE5D52D9B24F4B1"
        }
      },
      "life_cycle_state": "PENDING",
       {
           "type": "ADD_SUBSCRIPTIONS",
       "sub_provisioning_distribution_id": "B4AE85FCFA8C4329A2C6F767B879E070CC711DBFFA3347DA910CF03824E4727B",
            "process_name": null,
      "idreference_number": "C35201BD841E4B9DB1847F08527CF241"null,
        "executed_date": null
      },
    {
      ],
"scheduled_date": "2015-11-12T15:15:05",
      "response": null,
      "processerror_immediatelycode": null,
    
      "requestpriority": null,
    
      "logerror_informationdescription": null,
      "sequence_number": 1,
  {         "number": "20646",
      "updatedprocess_dateid": "2015-10-29T09:51:50"null,
      "name": null,
       "createdparameters_dateset": "2015-10-29T09:51:50", [
        {
          "createdservice_byca_unitid": "300",
          "id": "288FF681C1B04D509E9A6D0CE1104127"
       { },
        {
          "communitysmartcard_ca_nameid": "Internal Communitysc444444441",
          "id": "6DC89281ECEE4CB7B6E3C1C62C022197"
       "id": "48305F8849E3C18B227C5BE3A27BA6DF" },
        {
          "namesub_provisioning_distribution_id": "Admin UnitEF8C13A2F07D4F55B846A52CC81A53A6",
        
          "group_nameid": "FD5934D64A8A48C39761DD0918328C29"Main
 Group",       }
      ],
      "descriptionprocess_immediately": "r1 Test Description for resource request tab.Test Description for resource request tab."null,
      "request": null,
        "log_information": {
          "alternativeupdated_codedate": "MG"2015-11-12T15:15:06",
        "created_date": "2015-11-12T15:15:05",
     },   "created_by_unit": {
          "id": "updated_by_unit":48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
  {        "description": "r1",
          "communityalternative_namecode": "Internal CommunityMG",
          },
        "idupdated_by_unit": "48305F8849E3C18B227C5BE3A27BA6DF", {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "groupalternative_namecode": "Main GroupMG",
          },
        "descriptioncreated_by_user": {
"r1 Test Description for resource request tab.Test Description for resource request tab.",
         "person_name": "MPAdministrator",
          "alternative_codeusername": "MGMPAdministrator",
          "id": "1"
   },       },
        "createdupdated_by_user": {
          "person_name": "MPAdministrator",
  {        "username": "MPAdministrator",
          "person_nameid": "Marios Lannister",1"
        }
      },
      "usernamelife_cycle_state": "MPAdministratorPENDING",
        "type": "CANCEL_SUBSCRIPTIONS",
          "id": "1878B60FFE7B24907B8E36E577F9D5FF4",
      "process_name": null,
       }"reference_number": null,
      "executed_date": null
    },
  "updated_by_user":  {
      "scheduled_date": "2015-11-13T12:14:12",
     { "response": null,
          "error_code": null,
      "person_namepriority": "Marios LannisterREGULAR",
      "error_description": null,
      "sequence_number": null,
      "usernamenumber": "MPAdministrator20653",
           "process_id": null,
       "idname": "1"null,
      "parameters_set": [
        }{
           },
"message": "sdsad",
          "life_cycle_stateid": "PENDING",A3775EB117384DC9A4721F095F1440D3"
        },
      "type": "ADD_SUBSCRIPTIONS", {
          "process_namestar_indication_date_time": null,
"2015-11-19T00:00:00",
          "id": "D8E447B94E5F4B6886C6FB7C1B5ADFC8"0DB846BF5B5F476D80696AD1DE6E6E78"
        },
        {
          "referencesmartcard_ca_numberid": null"01900080211",
          "id": "executed_dateB528F3697AB1411B94799238300F4828":
null        }
}
      ],

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)

...

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

...

service_identifier

(mandatory)

...

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

...

smartcard_identifier

(mandatory)

...

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

...

start_date

(optional)

...

Restrictions

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

Response Data

...

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

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

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{   "process_immediately": 0,
      "request": null,
      "log_information": {
        "updated_date": "2015-11-13T12:14:12",
        "created_date": "2015-11-13T12:14:12",
        "created_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "statusalternative_code": "MG"
      {  },
         "messagecreated_by_user": "",
{
          "descriptionperson_name": "MPAdministrator",

          "codeusername": "OK"
    MPAdministrator",
  },        "dataid":  "1"
     {   },
        "scheduledupdated_by_dateuser": "2015-10-29T09:55:26",
{
          "responseperson_name": null"MPAdministrator",

          "error_codeusername": null"MPAdministrator",
           "priorityid": null,"1"
        }
  "error_description": null,     },
      "sequencelife_cycle_numberstate": 1"PENDING",
      "type": "SEND_MAIL_MESSAGE_TO_CLIENT",
      "numberid": "1885823BE553E22DA40DEAC130B6F3F4BD480",
 
         "process_idname": null,
    "INDIVIDUAL_MAIL_BARK_MESSAGES_UTILITY",
      "namereference_number": null,
    
      "parametersexecuted_setdate": null
    },
    {
[      "scheduled_date": null,
      "response": null,
{      "error_code": null,
      "priority": "REGULAR",
      "sub_provisioning_distribution_iderror_description": "B4AE85FCFA8C4329A2C6F767B879E070"null,
      "sequence_number": null,
           "idnumber": "C10E5761AD014428B217C36494F381F920943",
      "process_id": null,
      "name": }null,
      "parameters_set": [
        {
          "id": "4861A6D303A044DFB1EB4A3FFB13D196",
          "servicestb_ca_id": "9dc0001212335",
        },
        {
 "id": "49BEA99FE3CA4D02A3E819C4EF52D0D8"        "smartcard_ca_id": "smartcard00003",
      },    "id": "A03E003DA71D4ADD8942BF585C89EAD1"
         },
{         {
          "smartcard_casub_provisioning_distribution_id": "smrt200000552ADFE6A2FFD940F6A2BE7F42E7A3DB73",
          "id": "F2D6362098F84C9AA351B420E58790EB"
        },
        {
          "stb_sub_provisioning_distributor_id": "D43774D744444D8AA8E47192008BC359"F02EDAEF622D47E2AFAA18BC05421903",
          "id": "870B6E672AD94ED799C83E4A2E710BCF"
        }
      ],
      "process_immediately": null,
      "request": null,
      "log_information": {
         ]"updated_date": "2015-11-27T16:11:30",
           "process_immediately": null,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-10-29T09:55:26",
               "created_date": "2015-10-29T09:55:26",
               "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":
        "created_date": "2015-11-27T16:11:30",
        "created_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "life_cycle_state": "PENDING",
      "type": "CREATE_PAIRING",
      "id": "01F91FCCB115445C969C579447BE36CA",
      "process_name": "PAIRING_UTILITY",
      "reference_number": null,
      "executed_date": null
    },
    {
      "scheduled_date": "2015-11-27T16:16:45",
      "response": null,
      "error_code": null,
      "priority": "REGULAR",
      "error_description": null,
      "sequence_number": null,
      "number": "20944",
      "process_id": null,
      "name": null,
      "parameters_set": [
        {
          "smartcard_ca_id": null,
          "id": "9D8AD9C4B9C84E06A9A7A99C83BF9308"
        },
        {
          "message": "test",
          "id": "B993A81C497247DD991A6B3BBDF9CB7B"
        }
      ],
      "process_immediately": 0,
      "request": null,
      "log_information": {
        "updated_date": "2015-11-27T16:16:45",
        "created_date": "2015-11-27T16:16:45",
        "created_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "alternative_code": "MG"
        },
        "updated_by_unit": {
          "id": "48305F8849E3C18B227C5BE3A27BA6DF",
          "name": "Admin Unit",
          "description": "r1",
          "alternative_code": "MG"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        },
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "username": "MPAdministrator",
          "id": "1"
        }
      },
      "life_cycle_state": "PENDING",
      "type": "SEND_MAIL_MESSAGE_TO_CLIENT",
      "id": "6434E3FD069A4228BD00FF29E643E1D6",
      "process_name": "INDIVIDUAL_MAIL_BARK_MESSAGES_UTILITY",
      "reference_number": null,
      "executed_date": null
    }
  ]
}

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:

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

Restrictions

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

Response Data

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token" : "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

This method is creating Cancel Subscriptions provisioning requests in a pending life cycle state, by specifying the service and the smartcard that should be cancelled, and the subscription that the service should belong to.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

service_identifier

(mandatory)

Product identifier

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

Include Page

	V4:product_identifier
	V4:product_identifier

smartcard_identifier

(mandatory)

Installed Item identifier

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

Include Page

	V4:installed_item_identifier
	V4:installed_item_identifier

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

Include Page

	V4:conax_web_services_provisioning_request_complete
	V4:conax_web_services_provisioning_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
	"token" : "F0F5F41B7C7648019D79914D9D83A47A",
	"subscription_identifier" : { "number" : "S60712" },
	"service_identifier" : { "code" : "VOD & PPV" },
	"smartcard_identifier" : { "serial_number" : "smcb0000010" }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "scheduled_date": "2015-12-02T14:21:34",
    "response": null,
    "error_code": null,
    "priority": "REGULAR",
    "error_description": null,
    "sequence_number": 1,
    "number": "20959",
    "process_id": null,
    "name": null,
    "parameters_set": [
      {
        "sub_provisioning_distribution_id": "945FDB84E0B2458B83D1C6A9F545D920",
         "community_nameid": "BEEFC478955144D0B625CECFCB69DA40"Internal
  Community",    },
      {
        "smartcard_ca_id": "48305F8849E3C18B227C5BE3A27BA6DFsmcb0000010",
        "id": "3DE26397C1D44F128A4068FD05F0BE03"
      },
  "name": "Admin Unit",
    {
        "service_ca_id": null,
        "group_nameid": "Main Group7644F0887E434645B95577EA4AD65F11",
      }
     ],
      "descriptionprocess_immediately": "r1null,
Test Description for resource "request tab.Test Description for resource request tab.",
": null,
    "log_information": {
           "updated_date": "2015-12-02T14:21:34",
      "alternativecreated_codedate": "MG"2015-12-02T14:21:34",
      "created_by_unit": {
       },
       "community_name": "Internal Community",
        "created_by_userid": "48305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
   {     "group_name":      "Main Group",
        "person_namedescription": "Marios Lannisterr1",
        "alternative_code": "MG"
      },
  "username    "updated_by_unit": "MPAdministrator",{
        "community_name": "Internal Community",
        "id": "148305F8849E3C18B227C5BE3A27BA6DF",
        "name": "Admin Unit",
    },    "group_name": "Main  Group",
        "updated_by_userdescription": "r1",
          "alternative_code": "MG"
   {   },
      "created_by_user": {
        "person_name": "Marios Lannister",
        "username": "MPAdministrator",
         "usernameid": "MPAdministrator",1"
      },
      "updated_by_user": {
        "idperson_name": "1Marios Lannister",
          "username": "MPAdministrator",
    }    "id": "1"
      },
      },
    "life_cycle_state": "PENDING",
 
         "type": "CANCEL_SUBSCRIPTIONS",
  
        "process_name": null,
      "MANUAL",
    "id": "DD3B2596CFB94C928375209659842F2123C3DA789CA44E8A81DE8A8B2BEF0B9B",
     
     "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

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

  {
	"token"			: "ECB39805CD9649BD961060EA40BB3EFC",
	"subscription_identifier" : { "number" : "S60149"},
	"smartcard_set" : 
		[
			{
				"smartcard_ca_id" : "040900007200"
			}
		],
	"stb_set" : 
		[
			{
				"stb_ca_id" : "040900007201"
			}
		]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

   {
       "status":
       {
           "message": "",
           "description": "",
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-10-27T00:00:00",
           "response": null,
           "error_code": null,
           "priority": "REGULAR",
           "error_description": null,
           "sequence_number": null,
           "number": "18853",
           "process_id": null,
           "name": null,
           "parameters_set":
           [
               {
                   "stb_sub_provisioning_distributor_id": "152E10212834934888A20FFAEFA1806F",
                   "id": "82D39C8489DD4DADA9F5B49ED4A0F5C6"
               },
               {
                   "id": "CE0A4BB4076744629355D0D6ECD52AD1",
                   "stb_ca_id": "040900007201"
               },
               {
                   "smartcard_sub_provisioning_distribution_id": "D72AE7D5993F4BD797FFF1F28896DA13",
                   "id": "96D4E93ABE944621A67A14B5B9BBB1CB"
               },
               {
                   "smartcard_ca_id": "040900007200",
                   "id": "1DFF9663CB5848E2BAA5E8B66348769A"
               }
           ],
           "process_immediately": 0,
           "request": null,
           "log_information":
           {
               "updated_date": "2015-10-27T15:59:47",
               "created_date": "2015-10-27T15:59:47",
               "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": "CREATE_PAIRING",
           "process_name": "MANUAL",
           "id": "750789B3FD0540AAB68B74ECFD5BAB14",
           "reference_number": null,
           "executed_date": null
       }
    }

Versions Compared

Old Version 6

New Version 7

Key

GET conax_sms_sas/provisioning_requests/list

POST conax_sms_sas/provisioning_requests/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_requests/create_pairing

Page Comparison

Versions Compared

Old Version 6

New Version 7

Key

GET conax_sms_sas/provisioning_requests/list

POST conax_sms_sas/provisioning_requests/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/add_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_sms_sas/provisioning_requests/cancel_subscriptions

Resource URL

Parameters

Restrictions

Response Data

Examples

POST conax_web_services/provisioning_requests/create_pairing