API
Click here for a complete list of operations.
GetExternalEntitlements
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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 /WS_Modules/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/GetExternalEntitlements"
<?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>
<GetExternalEntitlements xmlns="http://api.tvinci.com/">
<sWSUserName>string</sWSUserName>
<sWSPassword>string</sWSPassword>
<userId>string</userId>
</GetExternalEntitlements>
</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>
<GetExternalEntitlementsResponse xmlns="http://api.tvinci.com/">
<GetExternalEntitlementsResult>
<Status>
<Code>int</Code>
<Message>string</Message>
<Args>
<KeyValuePair xsi:nil="true" />
<KeyValuePair xsi:nil="true" />
</Args>
</Status>
<Entitlements>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
</Entitlements>
</GetExternalEntitlementsResult>
</GetExternalEntitlementsResponse>
</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 /WS_Modules/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>
<GetExternalEntitlements xmlns="http://api.tvinci.com/">
<sWSUserName>string</sWSUserName>
<sWSPassword>string</sWSPassword>
<userId>string</userId>
</GetExternalEntitlements>
</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>
<GetExternalEntitlementsResponse xmlns="http://api.tvinci.com/">
<GetExternalEntitlementsResult>
<Status>
<Code>int</Code>
<Message>string</Message>
<Args>
<KeyValuePair xsi:nil="true" />
<KeyValuePair xsi:nil="true" />
</Args>
</Status>
<Entitlements>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
</Entitlements>
</GetExternalEntitlementsResult>
</GetExternalEntitlementsResponse>
</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 /WS_Modules/api.asmx/GetExternalEntitlements HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: application/x-www-form-urlencoded Content-Length: length sWSUserName=string&sWSPassword=string&userId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<OSSAdapterEntitlementsResponse 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>
<Entitlements>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
<ExternalEntitlement>
<PurchaseId>long</PurchaseId>
<ProductId>long</ProductId>
<ProductCode>string</ProductCode>
<EntitlementType>PPV or Subscription or Collection or ProgramAssetGroupOffer</EntitlementType>
<ContentId>string</ContentId>
<StartDateSeconds>long</StartDateSeconds>
<EndDateSeconds>long</EndDateSeconds>
</ExternalEntitlement>
</Entitlements>
</OSSAdapterEntitlementsResponse>