API
Click here for a complete list of operations.
TVAPI_CategoriesTree
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/TVAPI_CategoriesTree" <?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> <TVAPI_CategoriesTree xmlns="http://api.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <oInitObj> <m_oPicObjects> <PicObject> <m_nPicWidth>int</m_nPicWidth> <m_nPicHeight>int</m_nPicHeight> <m_oFileRequestObj xsi:nil="true" /> <m_sPicURL>string</m_sPicURL> <m_nPicBrandHeight>int</m_nPicBrandHeight> <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType> </PicObject> <PicObject> <m_nPicWidth>int</m_nPicWidth> <m_nPicHeight>int</m_nPicHeight> <m_oFileRequestObj xsi:nil="true" /> <m_sPicURL>string</m_sPicURL> <m_nPicBrandHeight>int</m_nPicBrandHeight> <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType> </PicObject> </m_oPicObjects> <m_oFileRequestObjects> <FileRequestObject> <m_sFileFormat>string</m_sFileFormat> <m_sFileQuality>string</m_sFileQuality> </FileRequestObject> <FileRequestObject> <m_sFileFormat>string</m_sFileFormat> <m_sFileQuality>string</m_sFileQuality> </FileRequestObject> </m_oFileRequestObjects> <m_oPlayerIMRequestObject> <m_sPalyerID>string</m_sPalyerID> <m_sPlayerKey>string</m_sPlayerKey> </m_oPlayerIMRequestObject> <m_oUserIMRequestObject> <m_sTvinciGuid>string</m_sTvinciGuid> <m_sSiteGuid>string</m_sSiteGuid> <m_sUserAgent>string</m_sUserAgent> <m_sUserIP>string</m_sUserIP> </m_oUserIMRequestObject> <m_oLanguageRequestObject> <m_sFullName>string</m_sFullName> </m_oLanguageRequestObject> <m_oExtraRequestObject> <m_bNoCache>boolean</m_bNoCache> <m_bZip>boolean</m_bZip> <m_bWithInfo>boolean</m_bWithInfo> <m_bWithFileTypes>boolean</m_bWithFileTypes> <m_bUseFinalEndDate>boolean</m_bUseFinalEndDate> </m_oExtraRequestObject> <m_sDevice>string</m_sDevice> <m_sAdminToken>string</m_sAdminToken> </oInitObj> <theInfoStruct> <m_bTitle>boolean</m_bTitle> <m_bDescription>boolean</m_bDescription> <m_bStatistics>boolean</m_bStatistics> <m_bPersonal>boolean</m_bPersonal> <m_bType>boolean</m_bType> <m_sMetaStrings> <string>string</string> <string>string</string> </m_sMetaStrings> <m_sMetaDoubles> <string>string</string> <string>string</string> </m_sMetaDoubles> <m_sMetaBools> <string>string</string> <string>string</string> </m_sMetaBools> <m_sTags> <string>string</string> <string>string</string> </m_sTags> </theInfoStruct> <nCategoryID>int</nCategoryID> <bWithChannels>boolean</bWithChannels> </TVAPI_CategoriesTree> </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> <TVAPI_CategoriesTreeResponse xmlns="http://api.tvinci.com/"> <TVAPI_CategoriesTreeResult> <CategoryObject> <m_oCategories> <CategoryObject xsi:nil="true" /> <CategoryObject xsi:nil="true" /> </m_oCategories> <m_oChannels> <ChannelObject xsi:nil="true" /> <ChannelObject xsi:nil="true" /> </m_oChannels> <m_sTitle>string</m_sTitle> <m_nID>int</m_nID> </CategoryObject> <CategoryObject> <m_oCategories> <CategoryObject xsi:nil="true" /> <CategoryObject xsi:nil="true" /> </m_oCategories> <m_oChannels> <ChannelObject xsi:nil="true" /> <ChannelObject xsi:nil="true" /> </m_oChannels> <m_sTitle>string</m_sTitle> <m_nID>int</m_nID> </CategoryObject> </TVAPI_CategoriesTreeResult> </TVAPI_CategoriesTreeResponse> </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> <TVAPI_CategoriesTree xmlns="http://api.tvinci.com/"> <sWSUserName>string</sWSUserName> <sWSPassword>string</sWSPassword> <oInitObj> <m_oPicObjects> <PicObject> <m_nPicWidth>int</m_nPicWidth> <m_nPicHeight>int</m_nPicHeight> <m_oFileRequestObj xsi:nil="true" /> <m_sPicURL>string</m_sPicURL> <m_nPicBrandHeight>int</m_nPicBrandHeight> <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType> </PicObject> <PicObject> <m_nPicWidth>int</m_nPicWidth> <m_nPicHeight>int</m_nPicHeight> <m_oFileRequestObj xsi:nil="true" /> <m_sPicURL>string</m_sPicURL> <m_nPicBrandHeight>int</m_nPicBrandHeight> <m_nPicBrandRecurringType>int</m_nPicBrandRecurringType> </PicObject> </m_oPicObjects> <m_oFileRequestObjects> <FileRequestObject> <m_sFileFormat>string</m_sFileFormat> <m_sFileQuality>string</m_sFileQuality> </FileRequestObject> <FileRequestObject> <m_sFileFormat>string</m_sFileFormat> <m_sFileQuality>string</m_sFileQuality> </FileRequestObject> </m_oFileRequestObjects> <m_oPlayerIMRequestObject> <m_sPalyerID>string</m_sPalyerID> <m_sPlayerKey>string</m_sPlayerKey> </m_oPlayerIMRequestObject> <m_oUserIMRequestObject> <m_sTvinciGuid>string</m_sTvinciGuid> <m_sSiteGuid>string</m_sSiteGuid> <m_sUserAgent>string</m_sUserAgent> <m_sUserIP>string</m_sUserIP> </m_oUserIMRequestObject> <m_oLanguageRequestObject> <m_sFullName>string</m_sFullName> </m_oLanguageRequestObject> <m_oExtraRequestObject> <m_bNoCache>boolean</m_bNoCache> <m_bZip>boolean</m_bZip> <m_bWithInfo>boolean</m_bWithInfo> <m_bWithFileTypes>boolean</m_bWithFileTypes> <m_bUseFinalEndDate>boolean</m_bUseFinalEndDate> </m_oExtraRequestObject> <m_sDevice>string</m_sDevice> <m_sAdminToken>string</m_sAdminToken> </oInitObj> <theInfoStruct> <m_bTitle>boolean</m_bTitle> <m_bDescription>boolean</m_bDescription> <m_bStatistics>boolean</m_bStatistics> <m_bPersonal>boolean</m_bPersonal> <m_bType>boolean</m_bType> <m_sMetaStrings> <string>string</string> <string>string</string> </m_sMetaStrings> <m_sMetaDoubles> <string>string</string> <string>string</string> </m_sMetaDoubles> <m_sMetaBools> <string>string</string> <string>string</string> </m_sMetaBools> <m_sTags> <string>string</string> <string>string</string> </m_sTags> </theInfoStruct> <nCategoryID>int</nCategoryID> <bWithChannels>boolean</bWithChannels> </TVAPI_CategoriesTree> </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> <TVAPI_CategoriesTreeResponse xmlns="http://api.tvinci.com/"> <TVAPI_CategoriesTreeResult> <CategoryObject> <m_oCategories> <CategoryObject xsi:nil="true" /> <CategoryObject xsi:nil="true" /> </m_oCategories> <m_oChannels> <ChannelObject xsi:nil="true" /> <ChannelObject xsi:nil="true" /> </m_oChannels> <m_sTitle>string</m_sTitle> <m_nID>int</m_nID> </CategoryObject> <CategoryObject> <m_oCategories> <CategoryObject xsi:nil="true" /> <CategoryObject xsi:nil="true" /> </m_oCategories> <m_oChannels> <ChannelObject xsi:nil="true" /> <ChannelObject xsi:nil="true" /> </m_oChannels> <m_sTitle>string</m_sTitle> <m_nID>int</m_nID> </CategoryObject> </TVAPI_CategoriesTreeResult> </TVAPI_CategoriesTreeResponse> </soap12:Body> </soap12:Envelope>