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:
| |||||||||
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:
|
| 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:
|
| process_id | String | The ID of the process that submitted the provisioning request |
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
Examples
HTTP Method: GET
Request:
Response:
{
"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,
"id": "C5C057CEF0615770BC09153C7740D2CA"
},
{
"sub_provisioning_distribution_id": "660EC70EB14FD3BB0BDF9A945436260B",
"id": "FFA301FE73E0D3639AEB95B8FF982012"
},
{
"smartcard_ca_id": "d100000000007",
"id": "9A8D07B05C11D9403F78D4791A8D1111"
},
{
"id": "EF8BEB3440D5E60BF961C4963D028A38"
}
],
"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",
"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": "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
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 | String | The type of the provisioning request to be retrieved. The supported types are the following:
|
life_cycle_state (semi-optional) | String | The life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED |
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 |
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 |
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:
|
| 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:
|
| process_id | String | The ID of the process that submitted the provisioning request |
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
Examples
HTTP Method: GET
Request:
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"scheduled_date": "2015-11-12T14:50:33",
"response": null,
"error_code": null,
"priority": null,
"error_description": null,
"sequence_number": 1,
"number": "20644",
"process_id": null,
"name": null,
"parameters_set": [
{
"service_ca_id": "300",
"id": "C17ADC11950F4CA0B154F6E135E7158F"
},
{
"sub_provisioning_distribution_id": "EF8C13A2F07D4F55B846A52CC81A53A6",
"id": "6E03189DF64445CD81B0DD8585DFA2D6"
},
{
"smartcard_ca_id": "sc444444441",
"id": "693382D40FA046D881DAED033DD07633"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-11-12T14:50:33",
"created_date": "2015-11-12T14:50:33",
"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": "ADD_SUBSCRIPTIONS",
"id": "5BE1C8D8CD83408DBD31421061CB4862",
"process_name": null,
"reference_number": null,
"executed_date": null
},
{
"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",
"id": "2C48205288394B879DD29DB7301B5AE6"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-11-12T14:57:35",
"created_date": "2015-11-12T14:57:35",
"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": "ADD_SUBSCRIPTIONS",
"id": "CC711DBFFA3347DA910CF03824E4727B",
"process_name": null,
"reference_number": null,
"executed_date": null
},
{
"scheduled_date": "2015-11-12T15:15:05",
"response": null,
"error_code": null,
"priority": null,
"error_description": null,
"sequence_number": 1,
"number": "20646",
"process_id": null,
"name": null,
"parameters_set": [
{
"service_ca_id": "300",
"id": "288FF681C1B04D509E9A6D0CE1104127"
},
{
"smartcard_ca_id": "sc444444441",
"id": "6DC89281ECEE4CB7B6E3C1C62C022197"
},
{
"sub_provisioning_distribution_id": "EF8C13A2F07D4F55B846A52CC81A53A6",
"id": "FD5934D64A8A48C39761DD0918328C29"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-11-12T15:15:06",
"created_date": "2015-11-12T15:15:05",
"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": "CANCEL_SUBSCRIPTIONS",
"id": "878B60FFE7B24907B8E36E577F9D5FF4",
"process_name": null,
"reference_number": null,
"executed_date": null
},
{
"scheduled_date": "2015-11-13T12:14:12",
"response": null,
"error_code": null,
"priority": "REGULAR",
"error_description": null,
"sequence_number": null,
"number": "20653",
"process_id": null,
"name": null,
"parameters_set": [
{
"message": "sdsad",
"id": "A3775EB117384DC9A4721F095F1440D3"
},
{
"star_indication_date_time": "2015-11-19T00:00:00",
"id": "0DB846BF5B5F476D80696AD1DE6E6E78"
},
{
"smartcard_ca_id": "01900080211",
"id": "B528F3697AB1411B94799238300F4828"
}
],
"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",
"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": "23BE553E22DA40DEAC130B6F3F4BD480",
"process_name": "INDIVIDUAL_MAIL_BARK_MESSAGES_UTILITY",
"reference_number": null,
"executed_date": null
},
{
"scheduled_date": null,
"response": null,
"error_code": null,
"priority": "REGULAR",
"error_description": null,
"sequence_number": null,
"number": "20943",
"process_id": null,
"name": null,
"parameters_set": [
{
"id": "4861A6D303A044DFB1EB4A3FFB13D196",
"stb_ca_id": "dc0001212335"
},
{
"smartcard_ca_id": "smartcard00003",
"id": "A03E003DA71D4ADD8942BF585C89EAD1"
},
{
"smartcard_sub_provisioning_distribution_id": "2ADFE6A2FFD940F6A2BE7F42E7A3DB73",
"id": "F2D6362098F84C9AA351B420E58790EB"
},
{
"stb_sub_provisioning_distributor_id": "F02EDAEF622D47E2AFAA18BC05421903",
"id": "870B6E672AD94ED799C83E4A2E710BCF"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-11-27T16:11:30",
"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:
| ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
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:
|
| 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:
|
| process_id | String | The ID of the process that submitted the provisioning request |
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
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "03B1C25A82B14478BF681FA6F7ADD815",
"subscription_identifier" : { "number" : "S60149" },
"service_identifier" : { "code" : "Silver" },
"smartcard_identifier" : { "serial_number" : "smrt20000055" }
}
Response:
{
"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:
| ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
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:
|
| 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:
|
| process_id | String | The ID of the process that submitted the provisioning request |
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
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "F0F5F41B7C7648019D79914D9D83A47A",
"subscription_identifier" : { "number" : "S60712" },
"service_identifier" : { "code" : "VOD & PPV" },
"smartcard_identifier" : { "serial_number" : "smcb0000010" }
}
Response:
{
"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",
"id": "BEEFC478955144D0B625CECFCB69DA40"
},
{
"smartcard_ca_id": "smcb0000010",
"id": "3DE26397C1D44F128A4068FD05F0BE03"
},
{
"service_ca_id": null,
"id": "7644F0887E434645B95577EA4AD65F11"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-12-02T14:21:34",
"created_date": "2015-12-02T14:21:34",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"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": "CANCEL_SUBSCRIPTIONS",
"process_name": "MANUAL",
"id": "23C3DA789CA44E8A81DE8A8B2BEF0B9B",
"reference_number": null,
"executed_date": null
}
}
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:
| |||||||||
( mandatory) | Conax Web Services Smartcard objects | The smartcards that will be paired | |||||||||
(mandatory) | Conax Web Services STB objects | The STBs that will be paired |
Referred Objects Response Data
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:
|
| 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:
|
| process_id | String | The ID of the process that submitted the provisioning request |
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
Examples
HTTP Method: POST
Request:
Body:
{
"token" : "F0F5F41B7C7648019D79914D9D83A47A",
"subscription_identifier" : { "number" : "S60712"},
"smartcard_set" :
[
{
"smartcard_ca_id" : "smcb0000010"
}
],
"stb_set" :
[
{
"stb_ca_id" : "dc0001212339"
}
]
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"scheduled_date": "2015-12-02T00:00:00",
"response": null,
"error_code": null,
"priority": "REGULAR",
"error_description": null,
"sequence_number": null,
"number": "20960",
"process_id": null,
"name": null,
"parameters_set": [
{
"smartcard_sub_provisioning_distribution_id": "A8F7C38D2F4140DBB5AC55DE47C6B567",
"id": "B1A77912B28F49588F25247F1E318E71"
},
{
"stb_sub_provisioning_distributor_id": "F1ACFA5658BF4E78ADC1A5F5BF1D6D18",
"id": "905903285ED14B7E9D26BF23E6F03B34"
},
{
"id": "415C3CAEAE2D408C8B9FEE6F1B6B3414",
"stb_ca_id": "dc0001212339"
},
{
"smartcard_ca_id": "smcb0000010",
"id": "F0044CB6B789497AA710A6170B30465D"
}
],
"process_immediately": null,
"request": null,
"log_information": {
"updated_date": "2015-12-02T14:26:00",
"created_date": "2015-12-02T14:26:00",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1",
"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": "60F74B4CF45B452899B45694BA97F2BA",
"reference_number": null,
"executed_date": null
}
}