SMSDomain API – SmartCard

Specs

The technical specification defining the payloads in this section can be found in the Service Delivery Platform API under the topic "SMS Domain API WSDL & XSD".

SmartCard use cases

Create SmartCard

Creates a SmartCard based on the details provided in a supplied SmartCard object.

Parameters

You must include the following parameters:

Parameter	Description
`smartCard`	Full SmartCard description as defined in SmartCard.

Response

Returns the SmartCard Specification of the created SmartCard instance.

Example

Sample request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:CreateSmartCard>
         <smartCard>
            <smartCardId>524234</smartCardId>
            <originKey>54523</originKey>
            <originId>1</originId>
            <casInstanceId>123</casInstanceId>
         </smartCard>
      </sms:CreateSmartCard>
   </soapenv:Body>

Sample response including the UID assigned to the new SmartCard:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <dvc:SmartCardSpecification>
         <smartCardId>1234</smartCardId>
         <uid>1234567890</uid>
      </dvc:SmartCardSpecification>
   </soapenv:Body>

Retrieve SmartCard

Retrieval operation of SmartCard is available through the following APIs in the Smartcard service:

Delete SmartCard

Deletes an existing SmartCard, identified by a given SmartCard Specification. Purchased CAS entitlements might also be removed during this process.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard Specification pointing to the SmartCard to delete.

Response

Empty response payload.

Example

Sample DeleteSmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:DeleteSmartCard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
      </sms:DeleteSmartCard>
   </soapenv:Body>

Suspend SmartCard

Suspend an existing SmartCard, identified by a given SmartCard Specification.

Changes the SmartCard status to UNAVAILABLE.
Disables the related Set Top Box.
Sends suspend command whenever needed.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard Specification pointing to the SmartCard to suspend.

Response

Empty response payload.

Example

Sample SuspendSmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:SuspendSmartCard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
      </sms:SuspendSmartCard>
   </soapenv:Body>

Reactivate SmartCard

Reactivates an existing SmartCard, identified by a given SmartCard Specification, including any ACL at the Account level, and sends the reactivate command as needed.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard Specification pointing to the SmartCard to reactivate.

Response

Empty response payload.

Example

Sample ReactivateSmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:ReactivateSmartCard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
      </sms:ReactivateSmartCard>
   </soapenv:Body>

Refresh SmartCard

Sends a refresh command to the SmartCard of a device identified by a given Device Specification. The device must be enabled.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The DeviceSpecification pointing to the device whose SmartCard will be refreshed.

Response

Empty response payload.

Example

Sample RefreshSmartCardrequest:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:RefreshSmartCard>
         <deviceSpecification>
            <uid>3421</uid>
         </deviceSpecification>
      </sms:RefreshSmartCard>
   </soapenv:Body>

Cancel SmartCard

Cancel an existing SmartCard, identified by a given SmartCard Specification. The SmartCard status will be set to CANCELLED. Purchased CAS entitlements can also be removed during this process.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard Specification pointing to the SmartCard to cancel.

Response

Empty response payload.

Example

Sample CancelSmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:CancelSmartCard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
      </sms:CancelSmartCard>
   </soapenv:Body>

Swap SmartCard

Swap out one SmartCard with another, keeping the same Device, Account and entitlements (ACL).

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard Specification pointing to the SmartCard to add.
`deviceSpecification`	The Set Top Box holding the SmartCard, identified via DeviceSpecification.

Response

Empty response payload.

Example

Sample SwapSmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:SwapSmartCard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
         <deviceSpecification>
            <uid>3421</uid>
         </deviceSpecification>
      </sms:SwapSmartCard>
   </soapenv:Body>

Add Products to SmartCard

Adds product entitlements to a specified SmartCard, given a SmartCard Specification.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard to update, as identified by a SmartCard Specification.
`products`	One or more Products offerings.

Response

Empty response payload.

Example

Sample addProductsToSmartcard request, given the SmartCardId inside the SmartCard Specification and the identity of the products to add:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:addProductsToSmartcard >
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
         <products>
            <originSpecification>
	           <originKey>352632454</originKey>
               <originId>1</originKey>
            </originSpecification>
         </products> 
      </sms:addProductsToSmartcard >
   </soapenv:Body>

Remove Products from SmartCard

Remove product entitlements from a specified SmartCard, given a SmartCard Specification.

Parameters

You must include the following parameters:

Parameter	Description
`smartCardSpecification`	The SmartCard to update, as identified by a SmartCard Specification.
`products`	One or more Products offerings.

Response

Empty response payload.

Example

Sample RemoveProductsToSmartcard request, given the SmartCardId inside the SmartCard Specification and the identity of the products to remove:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:removeProductsFromSmartcard>
         <smartCardSpecification>
            <smartCardId>1234</smartCardId>
         </smartCardSpecification>
         <products>
            <originSpecification>
	           <originKey>352632454</originKey>
               <originId>1</originKey>
            </originSpecification>
         </products> 
      </sms:removeProductsFromSmartcard>
   </soapenv:Body>