SDP APIs
Specs
The WSDL definitions are available from the following URL:
http://<server>/ws-gateway/ws/<service_name>?wsdl.
Account Service
Used for managing Account entities.
The WSDL definitions for the Account Service are available from the following URL:
http://<server>/ws-gateway/ws/accountservice?wsdl
Retrieve Accounts
The Account Service enables SMS systems to retrieve existing Account entities from SDP.
The following variants are supported:
Get Account By Account Number
Gets the Account with the specified accountNumber.
Method
getByAccountNumber
Parameters
| Name | Type | Description |
|---|---|---|
accountNumber | string | The account number provided at creation. |
Response
The Account object found, otherwise returns null.
Get Account By Account UID
Gets the Account with the specified UID.
Method
getByUID
Parameters
| Name | Type | Description |
|---|---|---|
uid | long | The internal identifier generated by SDP at creation. |
Response
The Account object found, otherwise returns null.
Get Account By Account Specification
Gets the Account with the specified AccountSpecification.
Method
getAccountBySpecification
Parameters
| Name | Type | Description |
|---|---|---|
aspec | accountSpecification | The account number provided at creation. |
Response
The Account object found, otherwise returns null.
Get Account By Origin Key and Origin Id
Gets the Account with the specified originKey and originId.
Method
getByOriginKeyAndId
Parameters
| Name | Type | Description |
|---|---|---|
originKey | string | The originKey provided at creation. |
originId | long | The originId provided at creation. |
Response
The Account object found, otherwise returns null.
Get Account By User UID
Gets the Account parent of the User specified by UID.
Method
getAccByUserUID
Parameters
| Name | Type | Description |
|---|---|---|
usrid | long | The primary key (UID) of the child User of the Account to retrieve. |
Response
The Account object found, otherwise returns null.
Device Service
Used for managing Device entities.
The WSDL definitions for the Device Service are available from the following URL:
http://<server>/ws-gateway/ws/deviceservice?wsdl
Retrieve Devices
The Device Service enables SMS systems to retrieve existing Device entities from SDP. It provides access to both the abstract Device objects as well as to specialised SetTopBox and MediaPlayer devices.
The following variants are supported:
Get Device By UID
Gets the Device with the specified UID.
Method
getByUID
Parameters
| Name | Type | Description |
|---|---|---|
uid | long | The internal identifier generated by SDP at creation. |
Response
The Device object found, otherwise returns null.
Get Device By UID and Type
Gets the Device with the specified UID and type.
Relevant device type values from the SMS viewpoint are STB and MP.
Method
getDeviceByUID
Parameters
| Name | Type | Description |
|---|---|---|
type | string | The type of the device to retrieve. |
uid | long | The internal identifier generated by SDP at creation. |
Response
The Device object found, if none is found or if the Device entity with the specified UID was of a different type null is returned.
Get Device By MAC Address
Gets the SetTopBox with the specified MAC Address.
Method
getDeviceByMACAddress
Parameters
| Name | Type | Description |
|---|---|---|
macAddress | string | The MAC address of the SetTopBox to retrieve. |
Response
The SetTopBox object found, otherwise returns null.
Get Device By CASN
Gets the SetTopBox with the specified CASN (Serial Number used by CAS system to identify a device).
This parameter must be unique within an SDP deployment, otherwise the method will return multiple objects.
Method
getDeviceByCASN
Parameters
| Name | Type | Description |
|---|---|---|
casn | string | The MAC address of the SetTopBox to retrieve. |
Response
A list with the SetTopBox objects found, if none are found returns an empty list.
Get Device By NUID
Gets the SetTopBox with the specified NUID (NAGRA Universal Identifier).
Method
getDeviceByNUID
Parameters
| Name | Type | Description |
|---|---|---|
pnuid | string | The NUID of the SetTopBox to retrieve. |
Response
The SetTopBox object found, otherwise returns null.
Get Device By SmartCard Id
Gets the SetTopBox linked with the specified SmartCard ID.
Method
getDeviceBySmartcardID
Parameters
| Name | Type | Description |
|---|---|---|
smartcardID | string | Identifier of the SmartCard linked to the SetTopBox. |
Response
The SetTopBox object found, otherwise returns null.
Get SetTopBox By Origin Key and Origin Id
Gets the SetTopBox with the specified originKey and originId.
Method
getSetTopBoxByOrigin
Parameters
| Name | Type | Description |
|---|---|---|
originKey | string | The originKey provided at creation. |
originId | long | The originId provided at creation. |
Response
The SetTopBox object found, otherwise returns null.
Get SetTopBox by Account UID and spid
Gets the SetTopBox with the specified Account UID and service provider id.
Method
getSetTopBoxByAccountUIDAndSpid
Parameters
| Name | Type | Description |
|---|---|---|
accountUID | long | The parent account's UID. |
spid | long | Service Provider ID. |
Response
The SetTopBox object found, otherwise returns null.
Get SetTopBox by UID
Gets the SetTopBox with the specified UID.
Method
getSetTopBoxByUID
Parameters
| Name | Type | Description |
|---|---|---|
uid | long | The internal identifier generated by SDP at creation. |
Response
The SetTopBox object found, otherwise returns null.
Get SetTopBox by Account UID
Gets the SetTopBox objects associated with an Account specified by its UID.
Method
getSetTopBoxByAccountUID
Parameters
| Name | Type | Description |
|---|---|---|
accountUID | long | The parent's account UID. |
Response
The list of SetTopBox objects found, if none are found an empty list is returned.
Get MediaPlayer by Account UID
Gets the MediaPlayer objects associated with an Account specified by its UID.
Method
getMediaPlayerByAccountUID
Parameters
| Name | Type | Description |
|---|---|---|
accountUID | long | The parent's account UID. |
Response
The list of MediaPlayer objects found, in none are found and empty list is returned.
Get MediaPlayer by ID
Gets the MediaPlayer with the specified ID.
Method
getMpById
Parameters
| Name | Type | Description |
|---|---|---|
id | long | The id of the MediaPlayer object assigned during device initialisation. |
Response
The MediaPlayer object found, otherwise returns null.
Get MediaPlayer by UID
Gets the MediaPlayer with the specified UID.
Method
getByUID
Parameters
| Name | Type | Description |
|---|---|---|
| uid | long | The internal identifier generated by SDP at creation. |
Response
The MediaPlayer object found, otherwise returns null.
User Service
Used for managing User entities.
The WSDL definitions for the User Service are available from the following URL:
http://<server>/ws-gateway/ws/userservice?wsdl
Create User
Creates a User in the SDP through the user service.
Method
create
Parameters
| Name | Type | Description |
|---|---|---|
acctUID | long | The Account UID. |
defaultUser | boolean | Whether the user is the default user forthis account. Accounts must have a single default User. |
dob | dateTime | Date of birth of user. |
hashSalt | string | HashSalt of the password. |
loginID | string | User login Id. |
name | string | User Name. |
password | string | User login Password. |
pin | string | User pin. |
purchaseAbility | string | Purchase ability of the user. |
ratingID | long | Rating Id. |
type | string | User type. |
Response
The userUID is returned in the response.
Update User
Updates user details in the SDP through the user service.
Method
update
Parameters
| Name | Type | Description |
|---|---|---|
acctUID | long | The Account UID. |
defaultUser | boolean | Whether the user is the default user for this account. Accounts must have a single default User. |
dob | dateTime | Date of birth of user. |
hashSalt | string | HashSalt of the password. |
loginID | string | User login Id. |
name | string | User name. |
password | string | User login password. |
pin | string | User pin. |
purchaseAbility | string | Purchase ability of the user. |
ratingID | long | Rating Id. |
type | string | User type. |
Response
The userUID is returned in the response.
Delete User
Deletes the user in the SDP through the user service.
Method
delete
Parameters
| Name | Type | Description |
|---|---|---|
acctUID | long | The Account UID. |
defaultUser | boolean | Whether the user is the default user for this account. Accounts must have a single default User. |
dob | dateTime | Date of birth of user. |
hashSalt | string | HashSalt of the password. |
loginID | string | User login Id. |
name | string | User name. |
password | string | User login password. |
pin | string | User pin. |
purchaseAbility | string | Purchase ability of the user. |
ratingID | long | Rating Id. |
type | string | User type. |
Response
The userUID is returned in the response.
Retrieve Users
The User Service enables SMS systems to retrieve existing User entities from SDP.
The following variants are supported:
Get Users By Account UID
Gets all the Users associated with the specified Account.
Method
getByAcctUID
Parameters
| Name | Type | Description |
|---|---|---|
acctid | long | The Account UID. |
Response
The list of User objects found, if none are found an empty list is returned.
Get Default User By Account UID
Gets the default User of the specified Account. This call will always return a User, because all Accounts must have a single default User.
Method
getDefaultUserByAcctUID
Parameters
| Name | Type | Description |
|---|---|---|
acctid | long | The Account UID. |
Response
The User object found.
Get User By Login
Retrieve, from storage, the User identified with the loginID.
Method
getByLoginId
Parameters
| Name | Type | Description |
|---|---|---|
loginId | string | Login identifier of the User. |
Response
The User object found, otherwise returns null.
Get User By UID
Gets the User with the specified UID.
Method
getByUID
Parameters
| Name | Type | Description |
|---|---|---|
uid | long | The User UID. |
Response
The User object found, otherwise returns null.
Get Users By Origin ID
Gets all the Users associated with the specified Origin Id (that is, for a given SMS client).
Method
getByOriginUID
Parameters
| Name | Type | Description |
|---|---|---|
originUID | long | The origin Id. |
Response
The list of User objects found, if none are found an empty list is returned.
SmartCard Service
Used for managing SmartCard entities.
The WSDL definitions for the SmartCard Service are available from the following URL:
http://<server>/ws-gateway/ws/smartcardservice?wsdl
Retrieve SmartCard
The SmartCard Service enables SMS systems to retrieve existing SmartCard entities from SDP.
The following variants are supported:
Get SmartCard by UID
Gets the SmartCard with the specified UID.
Method
getByUID
Parameters
| Name | Type | Description |
|---|---|---|
uid | long | The internal identifier generated by SDP at creation. |
Response
The SmartCard object found, otherwise returns null.
Get SmartCard by SmartCardID
Gets the SmartCard with the specified SmartCardID.
Method
getBySmartCardId
Parameters
| Name | Type | Description |
|---|---|---|
smartcardID | long | Smartcard ID. |
Response
The SmartCard object found, otherwise returns null.
Get SmartCard by Origin Id and Origin Key
Gets the SmartCard with the specified origin ID and origin key.
Method
getByOrigin
Parameters
| Name | Type | Description |
|---|---|---|
originId | long | The originId provided at creation. |
originKey | string | The originKey provided at creation. |
Response
The SmartCard object found, otherwise returns null.
Get SmartCard by SmartCard specification
Gets the SmartCard identified by the given SmartCardSpecification.
Method
getSmartCardBySpecification
Parameters
| Name | Type | Description |
|---|---|---|
sspec | SmartCardSpecification | Specification by which to identify the SmartCard. |
Response
The SmartCard object found, otherwise returns null.
AcquiredContentList Service
Used for managing AcquiredContentList entities.
The WSDL definitions for the AcquiredContentList Service are available from the following URL:
http://<server>/ws-gateway/ws/acquiredcontentlistservice?wsdl
Retrieve Account subscriptions and purchases
The AcquiredContentList Service enables SMS systems to retrieve existing account purchases and subscriptions from SDP.
Get ACLs by Account and ItemType
Returns a list of AcquiredContentList entries of the given type and expiry status that were acquired by the given Account.
Method
getByAccountUIDAndItemType
Parameters
| Name | Type | Description |
|---|---|---|
accountUID | long | The internal Account identifier generated by SDP at creation. |
statusByDate | string | Status of the purchase. One of:
Tip: Use |
itemType | string | Purchased item type: One of:
Tip: Use |
Response
The list of AcquiredContentList objects found, otherwise returns null.
AccessPoint Service
Used for managing AccessPoint entities.
The WSDL definitions for the AccessPoint Service are available from the following URL:
http://<server>/ws-gateway/ws/accesspointservice?wsdl
Retrieve AccessPoints
The AccessPointService enables the retrieval of the AccessPoint entities from SDP.
Get All AccessPoints
Retrieves a list of all the AccessPoints in the system.
Method
getAllAccessPoints
Parameters
None.
Response
The list of the AccessPoint entities in the system.
Create AccessPoints
The AccessPointService allows the creation of the AccessPoint entities from SDP.
Create AccessPoints
Creates a new AccessPoint entity in the system.
Method
create
Parameters
| Name | Type | Description |
|---|---|---|
pname | string | The name of the AccessPoint to create. This parameter is mandatory and the value must be unique. |
pdescr | string | An optional short description of the entity. |
isEnabled | boolean | status of the AccessPoint (true = enabled, false = disabled). |
apsAddr | string | Public address of the Application Server (not needed for OTT deployments). |
stsAddr | string | Public address of the Streaming Server (mandatory for OTT deployments). |
zoneID | integer | The IRD zone that covers clients served by this AccessPoint. Needed only when integrating OpenTV Platform with a CAS system. If you are using NAGRA CAS, you should assign IRD zones to regions in the CAS and fill this field appropriately. Optional. |
poriginuid | integer | The originId of the Entity (that is, the identifier used by SDP for the system that owns the object). Optional. |
poriginkey | string | The originKey of the Entity (that is, the identifier used for the object by the system that owns it). Optional. |
Response
The UID assigned to the created AccessPoint entity.
Update AccessPoints
The AccessPointService enables users to update existing AccessPoint entities in SDP.
Update AccessPoints
Updates an existing AccessPoints entity in the system.
Method
Update
Parameters
The request must contain a full AccessPoint object including all the fields. New field values will be applied.
Response
1 if the update was successful, 0 otherwise.
Delete AccessPoints
The AccessPointService enables the deletion of the AccessPoint entities from SDP.
Delete AccessPoints
Deletes one AccessPoints instance from the system.
Method
Delete
Parameters
The UID of the AccessPoint to delete.
Response
1 if the deletion was successful, 0 otherwise.
Session Service
Used for managing OTT Session entities.
The WSDL definitions for the Session Service are available from the following URL:
http://<server>/ws-gateway/ws/ottsessionservice?wsdl
Retrieve Sessions
OTTSession Service enables the retrieval of the OTT Session entities from the SDP.
Get Multiple Sessions with account number
Returns a list of OTT Session entries associated with the account number.
Method
getSessions
Parameters
| Name | Type | Description |
|---|---|---|
accountNumber | string | The account number of the account. |
startRow | long | Start row of the pagination range. |
endRow | long | End row of the pagination range. |
Response
The list of OTT Session objects found, if none are found null is returned.
Get a Session with SessionId
Returns a single OTT Session with the the given sessionId.
Method
getSessionBySessionId
Parameters
| Name | Type | Description |
|---|---|---|
ottSessionUid | long | Session Uid of the session. |
Response
Single OTT Session object found, otherwise returns null.
Tear-Down/Deregister a Session
This API tears down a session without validation if the tear-down request originated from the device that set up the session.
Method
tearDownNoDeviceChecks
Parameters
| Name | Type | Description |
|---|---|---|
sessionId | long | Session ID of the session. |