PhoneBook Web Service

PhoneBook

Click here for a complete list of operations.

Search

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 /PhoneBook.asmx HTTP/1.1
Host: dial.vc
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.tandberg.net/2004/06/PhoneBookSearch/Search"

<?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>
    <Search xmlns="http://www.tandberg.net/2004/06/PhoneBookSearch/">
      <Identification>
        <SystemName>string</SystemName>
        <MACAddress>string</MACAddress>
        <IPAddress>string</IPAddress>
        <ProductType>string</ProductType>
        <ProductID>string</ProductID>
        <SWVersion>string</SWVersion>
        <SerialNumber>string</SerialNumber>
        <SerialNo>string</SerialNo>
        <IPAddressV6>string</IPAddressV6>
      </Identification>
      <Scope>SingleLevel or SubTree</Scope>
      <StartFromId>string</StartFromId>
      <EndAtId>string</EndAtId>
      <MaxResult>int</MaxResult>
      <SearchString>string</SearchString>
      <SearchPath>string</SearchPath>
      <RangeInclusive>boolean</RangeInclusive>
      <CaseSensitiveSearch>boolean</CaseSensitiveSearch>
      <SearchType>FromStart or Ending or Free or T9</SearchType>
      <StartsWith>string</StartsWith>
    </Search>
  </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>
    <SearchResponse xmlns="http://www.tandberg.net/2004/06/PhoneBookSearch/">
      <SearchResult>
        <Name>string</Name>
        <Id>string</Id>
        <Catalog>
          <Name>string</Name>
          <Id>string</Id>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <NoOfEntries>int</NoOfEntries>
        </Catalog>
        <Catalog>
          <Name>string</Name>
          <Id>string</Id>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <NoOfEntries>int</NoOfEntries>
        </Catalog>
        <Entry>
          <Name>string</Name>
          <Id>string</Id>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <BaseDN>string</BaseDN>
          <SystemType>string</SystemType>
        </Entry>
        <Entry>
          <Name>string</Name>
          <Id>string</Id>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <BaseDN>string</BaseDN>
          <SystemType>string</SystemType>
        </Entry>
        <IsLast>boolean</IsLast>
        <IsFirst>boolean</IsFirst>
        <NoOfEntries>int</NoOfEntries>
      </SearchResult>
    </SearchResponse>
  </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 /PhoneBook.asmx HTTP/1.1
Host: dial.vc
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>
    <Search xmlns="http://www.tandberg.net/2004/06/PhoneBookSearch/">
      <Identification>
        <SystemName>string</SystemName>
        <MACAddress>string</MACAddress>
        <IPAddress>string</IPAddress>
        <ProductType>string</ProductType>
        <ProductID>string</ProductID>
        <SWVersion>string</SWVersion>
        <SerialNumber>string</SerialNumber>
        <SerialNo>string</SerialNo>
        <IPAddressV6>string</IPAddressV6>
      </Identification>
      <Scope>SingleLevel or SubTree</Scope>
      <StartFromId>string</StartFromId>
      <EndAtId>string</EndAtId>
      <MaxResult>int</MaxResult>
      <SearchString>string</SearchString>
      <SearchPath>string</SearchPath>
      <RangeInclusive>boolean</RangeInclusive>
      <CaseSensitiveSearch>boolean</CaseSensitiveSearch>
      <SearchType>FromStart or Ending or Free or T9</SearchType>
      <StartsWith>string</StartsWith>
    </Search>
  </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>
    <SearchResponse xmlns="http://www.tandberg.net/2004/06/PhoneBookSearch/">
      <SearchResult>
        <Name>string</Name>
        <Id>string</Id>
        <Catalog>
          <Name>string</Name>
          <Id>string</Id>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <NoOfEntries>int</NoOfEntries>
        </Catalog>
        <Catalog>
          <Name>string</Name>
          <Id>string</Id>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Catalog>
            <Name>string</Name>
            <Id>string</Id>
            <Catalog xsi:nil="true" />
            <Catalog xsi:nil="true" />
            <Entry xsi:nil="true" />
            <Entry xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <NoOfEntries>int</NoOfEntries>
          </Catalog>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <Entry>
            <Name>string</Name>
            <Id>string</Id>
            <Route xsi:nil="true" />
            <Route xsi:nil="true" />
            <IsLast>boolean</IsLast>
            <IsFirst>boolean</IsFirst>
            <BaseDN>string</BaseDN>
            <SystemType>string</SystemType>
          </Entry>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <NoOfEntries>int</NoOfEntries>
        </Catalog>
        <Entry>
          <Name>string</Name>
          <Id>string</Id>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <BaseDN>string</BaseDN>
          <SystemType>string</SystemType>
        </Entry>
        <Entry>
          <Name>string</Name>
          <Id>string</Id>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <Route>
            <CallType>string</CallType>
            <Protocol>Unknown or Auto or H320 or H323 or SIP or Skinny or IP or TLPH or H221 or V35 or H323Id or G3 or G703</Protocol>
            <Restrict>Restrict or Norestrict or Unknown</Restrict>
            <DialString>string</DialString>
            <Description>string</Description>
            <SystemType>string</SystemType>
          </Route>
          <IsLast>boolean</IsLast>
          <IsFirst>boolean</IsFirst>
          <BaseDN>string</BaseDN>
          <SystemType>string</SystemType>
        </Entry>
        <IsLast>boolean</IsLast>
        <IsFirst>boolean</IsFirst>
        <NoOfEntries>int</NoOfEntries>
      </SearchResult>
    </SearchResponse>
  </soap12:Body>
</soap12:Envelope>