module
Click here for a complete list of operations.
GetUserSubscriptions
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_cas_module.asmx HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://ca.tvinci.com/GetUserSubscriptions" <?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> <GetUserSubscriptions xmlns="http://ca.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <sSiteGUID>string</sSiteGUID> </GetUserSubscriptions> </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> <GetUserSubscriptionsResponse xmlns="http://ca.tvinci.com/"> <GetUserSubscriptionsResult> <status> <Code>int</Code> <Message>string</Message> <Args> <KeyValuePair xsi:nil="true" /> <KeyValuePair xsi:nil="true" /> </Args> </status> <entitelments> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails xsi:nil="true" /> </Entitlement> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails xsi:nil="true" /> </Entitlement> </entitelments> <totalItems>int</totalItems> </GetUserSubscriptionsResult> </GetUserSubscriptionsResponse> </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_cas_module.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> <GetUserSubscriptions xmlns="http://ca.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <sSiteGUID>string</sSiteGUID> </GetUserSubscriptions> </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> <GetUserSubscriptionsResponse xmlns="http://ca.tvinci.com/"> <GetUserSubscriptionsResult> <status> <Code>int</Code> <Message>string</Message> <Args> <KeyValuePair xsi:nil="true" /> <KeyValuePair xsi:nil="true" /> </Args> </status> <entitelments> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails xsi:nil="true" /> </Entitlement> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails xsi:nil="true" /> </Entitlement> </entitelments> <totalItems>int</totalItems> </GetUserSubscriptionsResult> </GetUserSubscriptionsResponse> </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_cas_module.asmx/GetUserSubscriptions HTTP/1.1 Host: extws.sgs1.ott.kaltura.com Content-Type: application/x-www-form-urlencoded Content-Length: length sWSUserName=string&sWSPassword=string&sSiteGUID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <Entitlements xmlns="http://ca.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> <entitelments> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails> <FullPrice d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <DiscountDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </PriceDetails> </Entitlement> <Entitlement> <mediaFileID>int</mediaFileID> <type>PPV or Subscription or Collection or ProgramAssetGroupOffer</type> <entitlementId>string</entitlementId> <currentUses>int</currentUses> <endDate>dateTime</endDate> <currentDate>dateTime</currentDate> <lastViewDate>dateTime</lastViewDate> <purchaseDate>dateTime</purchaseDate> <purchaseID>int</purchaseID> <paymentMethod>Unknown or CreditCard or SMS or PayPal or DebitCard or Ideal or Incaso or Gift or ChangeSubscription or Visa or MasterCard or Offline or M1 or SmartSun or InApp</paymentMethod> <deviceUDID>string</deviceUDID> <deviceName>string</deviceName> <cancelWindow>boolean</cancelWindow> <maxUses>int</maxUses> <nextRenewalDate>dateTime</nextRenewalDate> <recurringStatus>boolean</recurringStatus> <isRenewable>boolean</isRenewable> <paymentGatewayId>int</paymentGatewayId> <paymentMethodId>int</paymentMethodId> <IsInGracePeriod>boolean</IsInGracePeriod> <ScheduledSubscriptionId>long</ScheduledSubscriptionId> <IsSuspended>boolean</IsSuspended> <mediaID>int</mediaID> <UnifiedPaymentId>long</UnifiedPaymentId> <IsPending>boolean</IsPending> <PriceDetails> <FullPrice d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <DiscountDetails d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </PriceDetails> </Entitlement> </entitelments> <totalItems>int</totalItems> </Entitlements>