API Web Service

API

Click here for a complete list of operations.

GetParentalMediaRules

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
userName:
password:
siteGuid:
mediaId:
domainId:

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/GetParentalMediaRules"

<?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>
    <GetParentalMediaRules xmlns="http://api.tvinci.com/">
      <userName>string</userName>
      <password>string</password>
      <siteGuid>string</siteGuid>
      <mediaId>long</mediaId>
      <domainId>long</domainId>
    </GetParentalMediaRules>
  </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>
    <GetParentalMediaRulesResponse xmlns="http://api.tvinci.com/">
      <GetParentalMediaRulesResult>
        <status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </status>
        <rules>
          <ParentalRule>
            <id>long</id>
            <name>string</name>
            <description>string</description>
            <order>int</order>
            <mediaTagTypeId>int</mediaTagTypeId>
            <epgTagTypeId>int</epgTagTypeId>
            <blockAnonymousAccess>boolean</blockAnonymousAccess>
            <mediaTagValues xsi:nil="true" />
            <epgTagValues xsi:nil="true" />
            <isDefault>boolean</isDefault>
            <ruleType>All or Movies or TVSeries</ruleType>
            <level>User or Domain or Group</level>
            <mediaTagType>string</mediaTagType>
            <epgTagType>string</epgTagType>
            <isActive>boolean</isActive>
            <CreateDate>long</CreateDate>
            <UpdateDate>long</UpdateDate>
          </ParentalRule>
          <ParentalRule>
            <id>long</id>
            <name>string</name>
            <description>string</description>
            <order>int</order>
            <mediaTagTypeId>int</mediaTagTypeId>
            <epgTagTypeId>int</epgTagTypeId>
            <blockAnonymousAccess>boolean</blockAnonymousAccess>
            <mediaTagValues xsi:nil="true" />
            <epgTagValues xsi:nil="true" />
            <isDefault>boolean</isDefault>
            <ruleType>All or Movies or TVSeries</ruleType>
            <level>User or Domain or Group</level>
            <mediaTagType>string</mediaTagType>
            <epgTagType>string</epgTagType>
            <isActive>boolean</isActive>
            <CreateDate>long</CreateDate>
            <UpdateDate>long</UpdateDate>
          </ParentalRule>
        </rules>
      </GetParentalMediaRulesResult>
    </GetParentalMediaRulesResponse>
  </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>
    <GetParentalMediaRules xmlns="http://api.tvinci.com/">
      <userName>string</userName>
      <password>string</password>
      <siteGuid>string</siteGuid>
      <mediaId>long</mediaId>
      <domainId>long</domainId>
    </GetParentalMediaRules>
  </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>
    <GetParentalMediaRulesResponse xmlns="http://api.tvinci.com/">
      <GetParentalMediaRulesResult>
        <status>
          <Code>int</Code>
          <Message>string</Message>
          <Args>
            <KeyValuePair xsi:nil="true" />
            <KeyValuePair xsi:nil="true" />
          </Args>
        </status>
        <rules>
          <ParentalRule>
            <id>long</id>
            <name>string</name>
            <description>string</description>
            <order>int</order>
            <mediaTagTypeId>int</mediaTagTypeId>
            <epgTagTypeId>int</epgTagTypeId>
            <blockAnonymousAccess>boolean</blockAnonymousAccess>
            <mediaTagValues xsi:nil="true" />
            <epgTagValues xsi:nil="true" />
            <isDefault>boolean</isDefault>
            <ruleType>All or Movies or TVSeries</ruleType>
            <level>User or Domain or Group</level>
            <mediaTagType>string</mediaTagType>
            <epgTagType>string</epgTagType>
            <isActive>boolean</isActive>
            <CreateDate>long</CreateDate>
            <UpdateDate>long</UpdateDate>
          </ParentalRule>
          <ParentalRule>
            <id>long</id>
            <name>string</name>
            <description>string</description>
            <order>int</order>
            <mediaTagTypeId>int</mediaTagTypeId>
            <epgTagTypeId>int</epgTagTypeId>
            <blockAnonymousAccess>boolean</blockAnonymousAccess>
            <mediaTagValues xsi:nil="true" />
            <epgTagValues xsi:nil="true" />
            <isDefault>boolean</isDefault>
            <ruleType>All or Movies or TVSeries</ruleType>
            <level>User or Domain or Group</level>
            <mediaTagType>string</mediaTagType>
            <epgTagType>string</epgTagType>
            <isActive>boolean</isActive>
            <CreateDate>long</CreateDate>
            <UpdateDate>long</UpdateDate>
          </ParentalRule>
        </rules>
      </GetParentalMediaRulesResult>
    </GetParentalMediaRulesResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /api.asmx/GetParentalMediaRules HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userName=string&password=string&siteGuid=string&mediaId=string&domainId=string

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

<?xml version="1.0" encoding="utf-8"?>
<ParentalRulesResponse xmlns="http://api.tvinci.com/">
  <status>
    <Code>int</Code>
    <Message>string</Message>
    <Args>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
      <KeyValuePair>
        <key>string</key>
        <value>string</value>
      </KeyValuePair>
    </Args>
  </status>
  <rules>
    <ParentalRule>
      <id>long</id>
      <name>string</name>
      <description>string</description>
      <order>int</order>
      <mediaTagTypeId>int</mediaTagTypeId>
      <epgTagTypeId>int</epgTagTypeId>
      <blockAnonymousAccess>boolean</blockAnonymousAccess>
      <mediaTagValues>
        <string>string</string>
        <string>string</string>
      </mediaTagValues>
      <epgTagValues>
        <string>string</string>
        <string>string</string>
      </epgTagValues>
      <isDefault>boolean</isDefault>
      <ruleType>All or Movies or TVSeries</ruleType>
      <level>User or Domain or Group</level>
      <mediaTagType>string</mediaTagType>
      <epgTagType>string</epgTagType>
      <isActive>boolean</isActive>
      <CreateDate>long</CreateDate>
      <UpdateDate>long</UpdateDate>
    </ParentalRule>
    <ParentalRule>
      <id>long</id>
      <name>string</name>
      <description>string</description>
      <order>int</order>
      <mediaTagTypeId>int</mediaTagTypeId>
      <epgTagTypeId>int</epgTagTypeId>
      <blockAnonymousAccess>boolean</blockAnonymousAccess>
      <mediaTagValues>
        <string>string</string>
        <string>string</string>
      </mediaTagValues>
      <epgTagValues>
        <string>string</string>
        <string>string</string>
      </epgTagValues>
      <isDefault>boolean</isDefault>
      <ruleType>All or Movies or TVSeries</ruleType>
      <level>User or Domain or Group</level>
      <mediaTagType>string</mediaTagType>
      <epgTagType>string</epgTagType>
      <isActive>boolean</isActive>
      <CreateDate>long</CreateDate>
      <UpdateDate>long</UpdateDate>
    </ParentalRule>
  </rules>
</ParentalRulesResponse>