GET conax_sms_sas/provisioning_requests/show

Owned by Former user (Deleted)
Last updated: Jul 06, 2017 by p_demou (Deactivated)

Available from CRM.COM R8.0.0

This method returns information related with a Conax SMS-SAS Interface provisioning request. A single Conax SMS-SAS Interface provisioning request is returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

provisioning_request_identifier

(semi-optional)

Provisioning Request identifier

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

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning request

number

(semi-optional)

String

The number of the provisioning request

fields_set

(optional)

List of Strings, comma separated 

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

Restrictions

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

Response Data

Name

Type

Description

idStringThe ID of the retrieved provisioning request
numberStringThe number of the retrieved provisioning request
typeString

A code that uniquely identifies the type of provisioning request that is performed. The supported options are the following:

  • ADD_SUBSCRIPTIONS
  • CANCEL_SUBSCRIPTIONS
  • GET_ACTIVE_SUBSCRIPTIONS
  • CREATE_PAIRING
  • ADD_TO_EXISTING_PAIRING
  • GET_PAIRING_STATUS_FOR_CARD
  • GET_PAIRING_STATUS_FOR_PAIRING_MODULE
  • DISPLAY_FINGERPRINT
  • UPDATE_CA_PIN_TO_DEFAULT_VALUE
  • UPDATE_CA_PIN_TO_GIVEN_VALUE
  • SEND_MAIL_MESSAGE_TO_CLIENT
  • SEND_BARK_MESSAGE_TO_CLIENT
  • SEND_REPEATING_BARK_MESSAGE_TO_CLIENT
sequence_numberStringThe sequence number of the retrieved provisioning request
scheduled_dateDateThe date that the provisioning request is scheduled to be send
executed_dateDateThe date that the provisioning request was actually send
priorityString

The priority of the provisioning request. The supported values are the following:

  • REGULAR
  • EXPRESS
life_cycle_stateStringThe life cycle state of the retrieved provisioning request which can be PENDING, REJECTED or COMPLETED
requestStringThe actual request that was send to Conax
responseStringThe actual response that was received from Conax
reference_numberStringA reference number provided by Conax after receiving the request
error_codeStringThe error code received by CRM.COM or Conax in case that the provisioning request was rejected
error_descriptionStringThe error description received by CRM.COM or Conax in case that the provisioning request was rejected
process_nameString

The name of the process that submitted the provisioning request, which can be one of the following:

  • PROVISIONING_REQUEST_PROCESSING
  • MAIL_BARK_MESSAGE_UTILITY
  • PAIRING_UTILITY
  • FIINGERPRINTING_UTILITY
  • RESET_PIN
  • MANUAL
process_idString

The ID of the process that submitted the provisioning request

log_information

Log Information Object

The log information related with the retrieved provisioning request

parameters_setSet of Conax Web Services Provisioning Request Item objectsThe parameters which will be used to generate the Web Service Calls that will be send to Conax. That information differentiates based on the type of request

Referred Objects Response Data

 log_information object response data

Name

Type

Description

created_date

Date

The date that the retrieved record was created

updated_date

Date

The last date that the retrieved record was updated

created_by_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

 unit object response data

Name

Type

Description

id

String

The ID of the retrieved unit

name

String

The name of the retrieved unit

group_name

String

The name of the group that the retrieved unit belongs to

community_name

String

The name of the community that the retrieved unit belongs to

alternative_code

String

The alternative code of the retrieved unit

description

String

The description of the retrieved unit

 business unit object response data

Name

Type

Description

id

String

The ID of the retrieved business unit

name

String

The name of the retrieved business unit

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe name of the parent business unit that the retrieved business unit belongs to

 user object response data

Name

Type

Description

id

String

The ID of the retrieved user

username

String

The user name of the retrieved user

person_name

String

The full name of the retrieved user

email

String

The email of the retrieved user

 conax web services provisioning request item response data

Name

Type

Description

id

String

The ID of the retrieved provisioning request item

service_ca_idString

The subscription service CA ID that will

be affected by the provisioning request

service_subscription_provisioning_distributor_idStringThe ID of the subscription provisioning distributor linked with the subscription service that will be affected by the provisioning request
smartcard_ca_idStringThe smartcard  CA ID that will be affected by the provisioning request
smartcard_subscription_provisioning_distributor_idStringThe ID of the subscription provisioning distributor linked with the smartcard that will be affected by the provisioning request
stb_ca_idStringThe STB CA ID that will be affected by the provisioning request
stb_subscription_provisioning_distributor_idStringThe ID of the subscription provisioning distributor linked with the STB that will be affected by the provisioning request
   
sub_provisioning_distribution_idString  
service_ca_idString

The subscription service CA ID that will

be affected by the provisioning request

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

Examples

 Example 1

HTTP Method: GET

 

Request:

Response:

{
  "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"
  }
}