SMSDomain API – SetTopBox

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".

SetTopBox Use Cases

Create SetTopBox

Creates a SetTopBox based on the details provided in a supplied SetTopBox object. Optionally, a SmartCardSpecification can be provided as part of the SetTopBox description. If no SmartCard details are provided the SDP will attempt to derive such details, if appropriate.

Parameters

You must include the following parameters:

Parameter	Description
`stb`	Full set-top box description as defined in SetTopBox.

Response

Returns the created SetTopBox instance defined in SetTopBox.

Example

Sample create set-top box request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:CreateSetTopBox>
         <stb>
            <casn>355214344</casn>
            <originKey>54523</originKey>
            <originId>1</originId>
            <macAddress>43:6A:54:43:53:6F</macAddress>
            <smartCard>
               <smartCardId>524234</smartCardId>
            </smartCard>
            <description>Some set top box description</description>
            <account>
               <accountNumber>4252345</accountNumber>
            </account>
         </stb>
      </sms:CreateSetTopBox>
   </soapenv:Body>

Sample create set top box response, where SDP has assigned a UID to the SetTopBox instance:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <dvc:SetTopBox>
         <stb>
            <casn>355214344</casn>
            <uid>3421</uid>
            <originKey>54523</originKey>
            <originId>1</originId>
            <macAddress>43:6A:54:43:53:6F</macAddress>
            <smartCard>
               <smartCardId>524234</smartCardId>
            </smartCard>
            <description>Some set top box description</description>
            <deviceEnabled>true</deviceEnabled>
            <account>
               <accountNumber>4252345</accountNumber>
            </account>
         </stb>
      </dvc:SetTopBox>
   </soapenv:Body>

Create SetTopBox and SmartCard

Creates a SetTopBox, and SmartCard, based on the details supplied in the request (SetTopBox and SmartCard objects) and pairs them.

Parameters

You must include the following parameters:

Parameter	Description
`stb`	Full set top box description as defined in SetTopBox.
`smartcard`	Full smartcard description as defined in SmartCard.

Response

Returns the created SetTopBox instance defined in SetTopBox including SmartCard details.

Example

Sample create set top box and SmartCard request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:CreateSetTopBoxAndSmartCard>
         <stb>
            <casn>355214344</casn>
            <originKey>54523</originKey>
            <originId>1</originId>
            <macAddress>43:6A:54:43:53:6F</macAddress>
            <description>Some set top box description</description>
            <account>
               <accountNumber>4252345</accountNumber>
            </account>
         </stb>
         <smartcard>
            <smartCardId>524234</smartCardId>
            <casInstanceId>123</casInstanceId>
         </smartcard>
       </sms:CreateSetTopBoxAndSmartCard>
   </soapenv:Body>

Sample create set top box and SmartCard response, where SDP has assigned a UID to the SetTopBox instance:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <dvc:SetTopBox>
         <stb>
            <casn>355214344</casn>
            <uid>3421</uid>
            <originKey>54523</originKey>
            <originId>1</originId>
            <macAddress>43:6A:54:43:53:6F</macAddress>
            <smartCard>
               <smartCardId>524234</smartCardId>
            </smartCard>
            <description>Some set top box description</description>
            <deviceEnabled>true</deviceEnabled>
            <account>
               <accountNumber>4252345</accountNumber>
            </account>
         </stb>
      </dvc:SetTopBox>
   </soapenv:Body>

Retrieve SetTopBox

Retrieval operation of SetTopBox is available through the following APIs in the device service:

Update SetTopBox

Updates an existing SetTopBox in the SDP. Only RW parameters can be modified.

Parameters

You must include the following parameters:

Parameter	Description
`stb`	Full set top box description as defined in SetTopBox

Response

Empty response payload.

Example

Sample update Set Top Box request, given Set Top Box object, and changing a description:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:UpdateSetTopBox>
         <stb>
            <casn>355214344</casn>
            <originKey>54523</originKey>
            <originId>1</originId>
            <macAddress>43:6A:54:43:53:6F</macAddress>
            <smartCard>
               <smartCardId>524234</smartCardId>
            </smartCard>
            <description>A new set top box description</description>
            <account>
               <accountNumber>4252345</accountNumber>
            </account>
         </stb>
      </sms:UpdateSetTopBox>
   </soapenv:Body>

Sample update set top box response:

XML

   <soapenv:Header/>
   <soapenv:Body/>

Delete SetTopBox

Deletes an existing SetTopBox, based on an SetTopBox specification.

Depending on the type of device being removed, purchased CAS entitlements might also be removed during this process.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The SetTopBox specification to delete.

Response

Empty response payload.

Example

Sample delete set top box request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:DeleteSetTopBox>
         <deviceSpecification>
            <casn>355214344</casn>
         </deviceSpecification>
      </sms:DeleteSetTopBox>
   </soapenv:Body>

Sample delete set top box response:

XML

   <soapenv:Header/>
   <soapenv:Body/>

Suspend SetTopBox

Suspends a SetTopBox by setting the SetTopBox enabled status to false. Any related Smartcards are also marked with their status as UNAVAILABLE, but no entitlements are removed.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The SetTopBox specification to suspend.

Response

Empty response payload.

Example

Sample suspend set top box request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:SuspendSetTopBox>
         <deviceSpecification>
            <casn>355214344</casn>
         </deviceSpecification>
      </sms:SuspendSetTopBox>
   </soapenv:Body>

Sample suspend set top box response:

XML

   <soapenv:Header/>
   <soapenv:Body/>

Re-activate SetTopBox

Reactivates a SetTopBox by setting the SetTopBox enabled status to true. Any related Smartcards are also marked with their status as AVAILABLE.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The SetTopBox specification to reactivate.

Response

Empty response payload.

Example

Sample reactivate set top box request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:ReactivateSetTopBox>
         <deviceSpecification>
            <casn>355214344</casn>
         </deviceSpecification>
      </sms:ReactivateSetTopBox>
   </soapenv:Body>

Sample reactivate set top box response:

XML

   <soapenv:Header/>
   <soapenv:Body/>

Cancel SetTopBox

Cancels a SetTopBox by changing the Device-enabled status to false, and in addition removes any ACLs present for an associated SmartCard.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The SetTopBox specification to cancel.

Response

Empty response payload.

Example

Sample cancel set top box request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:CancelSetTopBox>
         <deviceSpecification>
            <casn>355214344</casn>
         </deviceSpecification>
      </sms:CancelSetTopBox>
   </soapenv:Body>

Sample cancel set top box response:

XML

   <soapenv:Header/>
   <soapenv:Body/>

Generate IRD for SetTopBox

Sends the provided command to a given Set Top Box.

Performs the following check:

The Set Top Box is enabled and has a SmartCard assigned.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The device identified via DeviceSpecification.
`commandId`	Identifier of the command to be sent.
`operationId`	Operation identifier (CAS specific).
`payload`	Any payload required (CAS specific).

Response

Empty response payload.

Example

Sample GenerateIrdForSetTopBox request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:GenerateIrdForSetTopBox>
         <deviceSpecification>
            <uid>3421</uid>
         </deviceSpecification>
         <commandId>5</commandId>
         <operationId>22</operationId>
         <payload></payload>
      </sms:GenerateIrdForSetTopBox>
   </soapenv:Body>

Set network by SetTopBox

Sets the network value provided in the request to a given SetTopBox.

Performs the following checks:

The device is ENABLED.
The network is a numeric value in the 0-999 range.

Parameters

You must include the following parameters:

Parameter	Description
`deviceSpecification`	The Set Top Box identified via DeviceSpecification.
`network`	Network identifier to which the device belongs (operator specific).

Response

Empty response payload.

Example

Sample SetNetworkBySetTopBox request:

XML

   <soapenv:Header/>
   <soapenv:Body>
      <sms:SetNetworkBySetTopBox>
         <deviceSpecification>
            <uid>3421</uid>
         </deviceSpecification>
         <network>555</network>
     </sms:SetNetworkBySetTopBox>
   </soapenv:Body>