Companywebcast API Wiki

MetaService 1.1 : The raw messages

Modified: 2013/02/16 22:27 by marcel - Categorized as: MetaService 1.1
The MetaService is a Soap 1.1 web service that uses "Transport" security.
With Soap, clients and services communicate using XML messages, and Transport security means they can only do it over SSL. Soap services often use the Web Services Definition Language (WSDL) standard to explain to the world what input they require, and what data the client can expect in return.
The WSDL file for the MetaService is available at this Url:


Most of the time you would use the Url above to generate code with tools in your platform or IDE. However, you may want to craft request messages by hand, and deserialize the response yourself, or you may just be interested in what the data that actually goes over the wire looks like.
The XML below was created by and copied from the excellent free Java tool SoapUI.


Edit

the WebcastSearch request

POST https://services.companywebcast.com/meta/1.1.5/metaservice.svc HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://schemas.companywebcast.com/pulse/metaservice/v1/MetaService/WebcastSearch"
User-Agent: Jakarta Commons-HttpClient/3.1
Host: services.companywebcast.com
Content-Length: 870

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <WebcastSearch xmlns="http://schemas.companywebcast.com/pulse/metaservice/v1">
         <Username>testuser</Username>
         <Password>0123456789</Password>
         <CustomerName xsi:nil="true"/>
         <TopicTitle xsi:nil="true"/>
         <SpeakerLastName xsi:nil="true"/>
         <WebcastTitle>Raadsvergadering</WebcastTitle>
         <Reference xsi:nil="true"/>
         <TagNames xsi:nil="true"/>
         <QueryText>abo</QueryText>
         <PeriodFrom xsi:nil="true"/>
         <PeriodTo xsi:nil="true"/>
         <Status xsi:nil="true"/>
         <PageNumber>0</PageNumber>
         <PageSize>2</PageSize>
      </WebcastSearch>
   </s:Body>
</s:Envelope>

Edit

the WebcastSearch response

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
P3P: CP="NOI CURa ADMa DEVa TAIa OUR BUS IND UNI COM NAV INT"
Date: Thu, 25 Mar 2010 22:38:30 GMT
Content-Length: 688

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <WebcastSearchResponse xmlns="http://schemas.companywebcast.com/pulse/metaservice/v1">
         <WebcastSearchResult>0</WebcastSearchResult>
         <WebcastSummaries xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <WebcastSummary>
               <Code>test/20121229_8</ Code>
               <CustomerName>Test</CustomerName>
               <Hits>
                  <Hit>
                     <Description>Raadsvergadering</Description>
                     <Id>87d456d0-3df4-4663-b890-28a56d8e7c90</Id>
                     <Type>Webcast</Type>
                  </Hit>
                  <Hit>
                     <Description>Ahmed  Aboutaleb</Description>
                     <Id>24ac2747-0a6a-407f-b7a4-cabc4d59741b</Id>
                     <Type>Speaker</Type>
                  </Hit>
               </Hits>
               <Languages>
                  <string>nl</string>
               </Languages>
               <ScheduledStart>2012-12-29T12:12:28Z</ScheduledStart>
               <Status>Ready</Status>
               <Title>Raadsvergadering</Title>
            </WebcastSummary>
            <WebcastSummary>
               <Code>test/20121229_18</ Code>
               <CustomerName>Test</CustomerName>
               <Hits>
                  <Hit>
                     <Description>Raadsvergadering</Description>
                     <Id>0b5d35d4-a56d-4946-a189-3264b37cafae</Id>
                     <Type>Webcast</Type>
                  </Hit>
                  <Hit>
                     <Description>Ahmed  Aboutaleb</Description>
                     <Id>f80896d9-3743-40fb-8646-d15ba15f7854</Id>
                     <Type>Speaker</Type>
                  </Hit>
               </Hits>
               <Languages>
                  <string>nl</string>
               </Languages>
               <ScheduledStart>2012-12-29T12:12:28Z</ScheduledStart>
               <Status>Ready</Status>
               <Title>Raadsvergadering</Title>
            </WebcastSummary>
         </WebcastSummaries>
      </WebcastSearchResponse>
   </s:Body>
</s:Envelope>

Edit

the WebcastGet request

POST https://services.companywebcast.com/meta/1.1.5/metaservice.svc HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "http://schemas.companywebcast.com/pulse/metaservice/v1/MetaService/WebcastGet"
User-Agent: Jakarta Commons-HttpClient/3.1
Host: services.companywebcast.com
Content-Length: 450

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://schemas.companywebcast.com/pulse/metaservice/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:WebcastGet>
         <v1:Username>testuser</v1:Username>
         <v1:Password>0123456789</v1:Password>
         <v1:Code>test/20121229_8</v1:Code>
         <v1:Language>nl</v1:Language>
      </v1:WebcastGet>
   </soapenv:Body>
</soapenv:Envelope>

Edit

the WebcastGet response

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Content-Encoding: gzip
Vary: Accept-Encoding
Server: Microsoft-IIS/7.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
P3P: CP="NOI CURa ADMa DEVa TAIa OUR BUS IND UNI COM NAV INT"
Date: Fri, 26 Mar 2010 21:53:48 GMT
Content-Length: 1188

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <WebcastGetResponse xmlns="http://schemas.companywebcast.com/pulse/metaservice/v1">
         <WebcastGetResult>0</WebcastGetResult>
         <Webcast xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ActualEnd i:nil="true"/>
            <ActualStart i:nil="true"/>
            <Annotations/>
            <Attachments/>
            <Code>test/20121229_8</ Code>
            <CustomerName>Test</CustomerName>
            <Id>87d456d0-3df4-4663-b890-28a56d8e7c90</Id>
            <Language>nl</Language>
            <Languages>
               <string>nl</string>
            </Languages>
            <Location>
               <Address>
                  <CountryCode>NL</CountryCode>
                  <Line1>Coolsingel 40</Line1>
                  <Line2>Rotterdam</Line2>
                  <PostalCode>3011 AD</PostalCode>
               </Address>
               <Coordinates>
                  <Latitude>51.922713</Latitude>
                  <Longitude>4.479128</Longitude>
               </Coordinates>
               <TimeZoneName/>
            </Location>
            <MediaStreams/>
            <ScheduledStart>2012-12-29T12:12:28Z</ScheduledStart>
            <Reference>Raadsvergadering managementservice test</Reference>
            <RegisterUrl>https://player.companywebcast.com/test/20121229_8/nl/authenticate</RegisterUrl>
            <Slides/>
            <Speakers>
               <Speaker>
                  <Category i:nil="true"/>
                  <Dob>1961-08-29T00:00:00</Dob>
                  <Email>Ahmed.Aboutaleb@Rotterdam.nl</Email>
                  <Events/>
                  <Homepage>http://nl.wikipedia.org/wiki/Ahmed_Aboutaleb</Homepage>
                  <Id>e763be54-9788-42d9-936e-3e88d0babbfe</Id>
                  <ImageUrl>http://upload.wikimedia.org/wikipedia/commons/thumb/6/66/Aboutaleb_Dutch_politician_kabinet_Balkenende_IV.jpg/200px-Aboutaleb_Dutch_politician_kabinet_Balkenende_IV.jpg</ImageUrl>
                  <Name>
                     <First>Ahmed</First>
                     <Last>Aboutaleb</Last>
                     <Middle i:nil="true"/>
                  </Name>
                  <Phone>0800-1545</Phone>
                  <Pob>Beni Sidel, Marokko</Pob>
                  <Reference i:nil="true"/>
                  <Role>Burgemeester</Role>
               </Speaker>
            </Speakers>
            <Status>Ready</Status>
            <Tags/>
            <Title>Raadsvergadering</Title>
            <Topics>
               <Topic>
                  <Attachments/>
                  <Events/>
                  <Id>00000000-0000-0000-0000-000000000000</Id>
                  <Reference i:nil="true"/>
                  <Tags/>
                  <Title>Dit is een agenda titel</Title>
               </Topic>
               <Topic>
                  <Attachments/>
                  <Events/>
                  <Id>00000000-0000-0000-0000-000000000000</Id>
                  <Reference i:nil="true"/>
                  <Tags/>
                  <Title>Topic met attachments</Title>
               </Topic>
            </Topics>
         </Webcast>
      </WebcastGetResponse>
   </s:Body>
</s:Envelope>