Example 9. HTTP Interface Request XML for DeleteAssociations Operation

The following example shows an XML request that can be sent using an HTTP POST to the DeleteAssociations.aspx operation page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="oids">1234</param>
  <param name="oids">5678</param>
</request>

Example 10. C# Code Using the Web Services Client Library to Invoke the DeleteAssociations Operation

The following example shows how to delete associations using the Web Services Client library.

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode results = client.DeleteAssociations("mytopicmap", new string[] {"1234", "5678"});

Example 11. HTTP Interface Request XML for DeleteTopics Operation

The following request XML can be POSTed to the DeleteTopics.aspx page to request the deletion of two topics from the topic map.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="oids">1234</param>
  <param name="oids">5678</param>
</request>

Example 12. C# Code Using the Web Services Client to Invoke the DeleteTopics Operation

The following code snippet shows how to delete two topics from a topic map using the Web Services Client library:

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode results = client.DeleteTopics("mytopicmap", new string[] {"1234", "5678"});

Example 13. HTTP POST Body to Invoke the GetHierarchy Operation

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="hierarchydefid">1234</param>
</request>

Example 14. HTTP GET URL to Invoke the GetHierarchy Operation

http://topicmap.mycorp.com/tmws/GetHierarchy.aspx?topicmap=mytopicmap&hierarchydefid=1234

Example 15. C# Code to Invoke the GetHierarchy Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode hierarchy = client.GetHierarchy("mytopicmap", "1234");

Example 16. HTTP POST Body to Invoke the GetHierarchyRoots Operation

<request>
  <param name="topicmap">mytopicmap</param>
</request>

Example 17. HTTP GET URL to Invoke the GetHierarchyRoots Operation

http://topicmap.mycorp.com/tmws/GetHierarchyRoots.aspx?topicmap=mytopicmap

Example 18. C# Code to Invoke the GetHierarchyRoots Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode hierarchyRoots = client.GetHierarchyRoots("mytopicmap");

Example 19. HTTP POST Body to Invoke the GetObjectBySourceLocator Operation

The following example could be used in the body of an HTTP POST request to the GetObjectBySourceLocator.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="sourcelocator">http://www.example.com/topicmaps/foo.xtm#bar</param>
</request>

Example 20. HTTP GET URL to Invoke the GetObjectBySourceLocator Operation

The following example shows how to invoke the GetObjectBySourceLocator operation using an HTTP GET. Note that the source locator value should be properly escaped within the URL string.

http://topicmap.mycorp.com/tmws/GetObjectBySourceLocator.aspx?topicmap=mytopicmap&sourcelocator=http%3a%2f%2f...

Example 21. C# Code to Invoke the GetObjectBySourceLocator Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode tmFragment = client.GetObjectBySourceLocator("mytopicmap", "http://www.example.com/topicmaps/foo.xtm#bar");

Example 22. HTTP POST Body to Invoke the GetTopic Operation

The following example could be used in the body of an HTTP POST request to the GetTopic.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="topicid">1234</param>
</request>

Example 23. HTTP GET URL to Invoke the GetTopic Operation

The following example shows how to invoke the GetTopic operation using an HTTP GET.

http://topicmap.mycorp.com/tmws/GetTopic.aspx?topicmap=mytopicmap&topicid=1234

Example 24. C# Code to Invoke the GetObjectBySourceLocator Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode tmFragment = client.GetTopic("mytopicmap", "1234");

Example 25. HTTP POST Body to Invoke the GetTopicBySubjectIdentifier Operation

The following example could be used in the body of an HTTP POST request to the GetTopicBySubjectIdentifier.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="locator">http://psi.example.com/companies/MSFT</param>
</request>

Example 26. HTTP GET URL to Invoke the GetTopicBySubjectIdentifier Operation

The following example shows how to invoke the GetTopicBySubjectIdentifier operation using an HTTP GET. Note that the subject identifier value should be properly escaped within the URL string.

http://topicmap.mycorp.com/tmws/GetTopicBySubjectIdentifier?topicmap=mytopicmap&locator=http%3a%2f%2f...

Example 27. C# Code to Invoke the GetTopicBySubjectIdentifier Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode tmFragment = client.GetTopicBySubjectIdentifier("mytopicmap", "http://psi.example.com/companies/MSFT");

Example 28. HTTP POST Body to Invoke the GetTopicMaps Operation

The following example could be used in the body of an HTTP POST request to the GetTopicMaps request page.

<request />

Example 29. HTTP GET URL to Invoke the GetTopicMaps Operation

The following example shows how to invoke the GetTopicMaps operation using an HTTP GET.

http://topicmap.mycorp.com/tmws/GetTopicMaps.aspx

Example 30. C# Code to Invoke the GetTopicMaps Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode tmSystem = client.GetTopicMaps();

Example 31. HTTP POST Body to Invoke the GetTopicsByName Operation

The following example could be used in the body of an HTTP POST request to the GetTopicsByName.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="name">NetworkedPlanet</param>
</request>

Example 32. HTTP GET URL to Invoke the GetObjectBySourceLocator Operation

The following example shows how to invoke the GetObjectBySourceLocator operation using an HTTP GET. Note that the name value should be properly escaped within the URL string if it contains reserved or non-ASCII characters.

http://topicmap.mycorp.com/tmws/GetTopicsByName?topicmap=mytopicmap&name=NetworkedPlanet

Example 33. C# Code to Invoke the GetObjectBySourceLocator Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode tmFragment = client.GetTopicsByName("mytopicmap", "NetworkedPlanet");

Example 34. HTTP POST Body to Invoke the GetTopicsByType Operation

The following example could be used in the body of an HTTP POST request to the GetTopicsByType.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="typeid">1234</param>
</request>

Example 35. HTTP GET URL to Invoke the GetTopicsByType Operation

The following example shows how to invoke the GetTopicsByType operation using an HTTP GET.

http://topicmap.mycorp.com/tmws/GetTopicsByType.aspx?topicmap=mytopicmap&typeid=1234

Example 36. C# Code to Invoke the GetObjectBySourceLocator Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode tmFragment = client.GetTopicsByType("mytopicmap", "1234");

Example 37. HTTP POST Body to Invoke the GetTopicTypes Operation

The following example could be used in the body of an HTTP POST request to the GetTopicTypes.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
</request>

Example 38. HTTP GET URL to Invoke the GetTopicTypes Operation

The following example shows how to invoke the GetObjectBySourceLocator operation using an HTTP GET.

http://topicmap.mycorp.com/tmws/GetTopicTypes.aspx?topicmap=mytopicmap

Example 39. C# Code to Invoke the GetObjectBySourceLocator Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlNode tmFragment = client.GetTopicTypes("mytopicmap");

Example 40. HTTP POST Body to Invoke the Query Operation

The following example could be used in the body of an HTTP POST request to the Query.aspx request page.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="queryid">MyQuery</param>
  <param name="args">ARG1</param>
  <param name="args">ARG2</param>
</request>

Example 41. HTTP GET URL to Invoke the Query Operation

The following example shows how to invoke the Query operation using an HTTP GET. Note that this interface can be only used if the query takes one argument or no arguments.

http://topicmap.mycorp.com/tmws/Query.aspx?topicmap=mytopicmap&queryid=MyQuery&args=ARG1

Example 42. C# Code to Invoke the Query Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");

XmlNode results = client.Query("mytopicmap", "MyQuery", new string[] { "ARG1", "ARG2" });

// The results can be deserialized as a DataSet which will always contain a single table:
DataSet dsResults = new DataSet();
dsResults.ReadXml(new XmlNodeReader(results));

// Now you can access the results table as:
DataTable dt = dsResults.Tables[0];

Example 43. HTTP POST Body to Invoke the Save Operation

The following example could be used in the body of an HTTP POST request to the Save.aspx request page. The updated topic will have one name and one occurence after the operation completes.

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="tmfragment">
    <tmf:topicmap xmlns:tmf="http://www.networkedplanet.com/2005/01/topicmap/data/">
      <tmf:topiclist>
        <tmf:topic oid="1234">
          <tmf:names>
            <tmf:name>
              <tmf:namestring>Mega Corp Limited</tmf:namestring>
            </tmf:name>
          </tmf:names>
          <tmf:occurrences>
            <tmf:occurrence>
              <tmf:type psi="http://psi.example.com/organizations/stock-ticker"/>
              <tmf:resourcedata>MGCP</tmf:resourcedata>
            </tmf:occurrence>
          </tmf:occurrences>
        </tmf:topic>
      </tmf:topiclist>
    </tmf:topicmap>
  </param>
</request>

Example 44. C# Code to Invoke the Save Operation using the Web Services Client Library

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
// NOTE: This example shows building the request using CreateElement calls.
// You could also use XmlDocument.Load() to read from an external source
// or an internal string.
string tmfNS = "http://www.networkedplanet.com/2005/01/topicmap/data/";
XmlDocument requestDoc = new XmlDocument();
XmlElement topicmap = requestDoc.CreateElement("topicmap", tmfNS);
XmlElement topiclist = requestDoc.CreateElement("topiclist", tmfNS);
XmlElement topic = requestDoc.CreateElement("topic", tmfNS);
topic.SetAttribute("oid", "1234");
XmlElement names = requestDoc.CreateElement("names", tmfNS);
XmlElement name= requestDoc.CreateElement("name", tmfNS);
XmlElement namestring = requestDoc.CreateElement("namestring", tmfNS);
namestring.InnerText="Mega Corp Limited";
name.AppendChild(namestring);
names.AppendChild(name);
topic.AppendChild(names);
topiclist.AppendChild(topic);
topicmap.AppendChild(topiclist);
requestDoc.AppendChild(topicmap);

client.Save("mytopicmap", requestDoc);

Example 45. Invoking the ProcessTransaction Method using an HTTP POST

<request>
  <param name="topicmap">mytopicmap</param>
  <param name="transaction">
    <txn:TopicMapTransaction xmlns:txn="http://www.networkedplanet.com/schema/transaction">
     <!-- Operation descriptions go here -->
    </txn:TopicMapTransaction>
  </param>
</request>

Example 46. Invoking The ProcessTransaction Method using C# and the Web Services Client Library

The method interface for the ProcessTransaction proxy simply takes an XmlNode as the transaction parameter value and so can be invoked as follows:

TMSClient client = new TMSClient("http://topicmap.mycorp.com/tmws/TMService.asmx");
XmlDocument txnDoc = new XmlDocument();
// Code to populate the txnDoc goes here
client.ProcessTransaction("mytopicmap", txnDoc);

The transaction XML can be constructed in a number of ways. It can be read from a local file or from an internal string using the XmlDocument.Load() method, or you can construct the document element by element using the XmlDocument.CreateElement() and other related methods.