API

Click here for a complete list of operations.

GetNpvrRules

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tvinci.com/GetNpvrRules"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNpvrRules xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <recordedProgram>
        <RecordingID>string</RecordingID>
        <IsAssetProtected>boolean</IsAssetProtected>
        <ChannelName>string</ChannelName>
        <RecordSource>string</RecordSource>
      </recordedProgram>
      <siteGuid>int</siteGuid>
      <sIP>string</sIP>
      <deviceUdid>string</deviceUdid>
    </GetNpvrRules>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetNpvrRulesResponse xmlns="http://api.tvinci.com/">
      <GetNpvrRulesResult>
        <GroupRule>
          <RuleID>int</RuleID>
          <Name>string</Name>
          <TagTypeID>int</TagTypeID>
          <DynamicDataKey>string</DynamicDataKey>
          <TagValue>string</TagValue>
          <AllTagValues>
            <string>string</string>
            <string>string</string>
          </AllTagValues>
          <IsActive>boolean</IsActive>
          <BlockType>Allowed or Validation or AgeBlock or Geo or Device or UserType or AnonymousAccessBlock or AssetUserBlock</BlockType>
          <GroupRuleType>Unknown or Parental or Purchase or Device or EPG or AssetUser</GroupRuleType>
          <BlockAnonymous>boolean</BlockAnonymous>
        </GroupRule>
        <GroupRule>
          <RuleID>int</RuleID>
          <Name>string</Name>
          <TagTypeID>int</TagTypeID>
          <DynamicDataKey>string</DynamicDataKey>
          <TagValue>string</TagValue>
          <AllTagValues>
            <string>string</string>
            <string>string</string>
          </AllTagValues>
          <IsActive>boolean</IsActive>
          <BlockType>Allowed or Validation or AgeBlock or Geo or Device or UserType or AnonymousAccessBlock or AssetUserBlock</BlockType>
          <GroupRuleType>Unknown or Parental or Purchase or Device or EPG or AssetUser</GroupRuleType>
          <BlockAnonymous>boolean</BlockAnonymous>
        </GroupRule>
      </GetNpvrRulesResult>
    </GetNpvrRulesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /api.asmx HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetNpvrRules xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <recordedProgram>
        <RecordingID>string</RecordingID>
        <IsAssetProtected>boolean</IsAssetProtected>
        <ChannelName>string</ChannelName>
        <RecordSource>string</RecordSource>
      </recordedProgram>
      <siteGuid>int</siteGuid>
      <sIP>string</sIP>
      <deviceUdid>string</deviceUdid>
    </GetNpvrRules>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetNpvrRulesResponse xmlns="http://api.tvinci.com/">
      <GetNpvrRulesResult>
        <GroupRule>
          <RuleID>int</RuleID>
          <Name>string</Name>
          <TagTypeID>int</TagTypeID>
          <DynamicDataKey>string</DynamicDataKey>
          <TagValue>string</TagValue>
          <AllTagValues>
            <string>string</string>
            <string>string</string>
          </AllTagValues>
          <IsActive>boolean</IsActive>
          <BlockType>Allowed or Validation or AgeBlock or Geo or Device or UserType or AnonymousAccessBlock or AssetUserBlock</BlockType>
          <GroupRuleType>Unknown or Parental or Purchase or Device or EPG or AssetUser</GroupRuleType>
          <BlockAnonymous>boolean</BlockAnonymous>
        </GroupRule>
        <GroupRule>
          <RuleID>int</RuleID>
          <Name>string</Name>
          <TagTypeID>int</TagTypeID>
          <DynamicDataKey>string</DynamicDataKey>
          <TagValue>string</TagValue>
          <AllTagValues>
            <string>string</string>
            <string>string</string>
          </AllTagValues>
          <IsActive>boolean</IsActive>
          <BlockType>Allowed or Validation or AgeBlock or Geo or Device or UserType or AnonymousAccessBlock or AssetUserBlock</BlockType>
          <GroupRuleType>Unknown or Parental or Purchase or Device or EPG or AssetUser</GroupRuleType>
          <BlockAnonymous>boolean</BlockAnonymous>
        </GroupRule>
      </GetNpvrRulesResult>
    </GetNpvrRulesResponse>
  </soap12:Body>
</soap12:Envelope>