Webservice Interface

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

Get Tags By Name

Returns all Tags having the input parameter name. [Test]

GET /ws/GetTagsByName/?tagname=string HTTP/1.1  
        Host: www.fuzzzy.com
        

Get Tags By Partial Name

Returns all Tags starting with the string. tagname must be atleast two characters long. Parameter uid is optional and used for specifying personalized search. [Test]

GET /ws/GetTagsByNameStartingWith/?tagname=string&uid=integer    HTTP/1.1
        Host: www.fuzzzy.com
        

Get Tag By Id

Returns complete data for a single Tag. [Test]

GET /ws/GetTagById/?id=integer HTTP/1.1
        Host: www.fuzzzy.com
        

Get Tag By Subject Identifier

Returns complete data for a single Tag. [Test]

GET /ws/GetTagByPSI/?psi=string HTTP/1.1
        Host: www.fuzzzy.com
        

Get All Tags

Returns a list of all Tag names and id's. (Go to the Export page for complete XTM) [Test]

GET /ws/getAllTags/ HTTP/1.1
        Host: www.fuzzzy.com
        

Get Last Created Tags

Returns the last 10 tags created. [Test]

GET /ws/GetNewTags/ HTTP/1.1
        Host: www.fuzzzy.com
        

Get Top Tags

Returns the top 10 most used tags. [Test]

GET /ws/GetTopTags/ HTTP/1.1
        Host: www.fuzzzy.com
        

Get Favorite Tags For User

Returns a list of favorite Tags for a user. [Test]

GET /ws/GetFavoriteTagsForUser/?uid=integer HTTP/1.1
        Host: www.fuzzzy.com
        

Get Most Used Tags For User

Returns the top 20 most used Tags for a user. [Test]

GET /ws/getMostUsedTagsForUser/?uid=integer HTTP/1.1
        Host: www.fuzzzy.com
        

Sample Response

HTTP/1.1 200 OK
            Content-Type: text/xml; charset=utf-8
            Content-Length: length

            <?xml version="1.0" encoding="utf-8" ?> 
            <topicmap xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
            xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
            oid="157" topicmapname="Fuzzzy" 
            xmlns="http://www.networkedplanet.com/2005/01/topicmap/data/">
            <topiclist>
            <topic oid="3053" version="2">
                <topicTypes>
                    <topicref displayname="Tag" tref="444" /> 
                </topicTypes>
                <names>
                    <name oid="3054">
                        <namestring>Roy Lachica</namestring> 
                    </name>
                </names>
                <occurrences>
                    <occurrence oid="3055">
                        <type displayname="Description" tref="207" /> 
                        <resourcedata>the fuzzzy guy</resourcedata> 
                    </occurrence>
                </occurrences>
                <associations>
                    <association oid="3056">
                        <type displayname="Is" tref="2773" /> 
                        <playsrole displayname="Is" tref="2775" /> 
                        <role>
                            <roletype displayname="Is" tref="2775" /> 
                            <player displayname="sexy" tref="3050" /> 
                        </role>
                    </association>
                    <association oid="3059">
                        <type displayname="Created by" tref="1423" /> 
                        <playsrole displayname="Has created" tref="1427" /> 
                        <role>
                            <roletype displayname="Is created by" tref="1425" /> 
                            <player displayname="Fuzzzy" tref="2544" /> 
                        </role>
                    </association>
                </associations>        
             </topic>
            </topiclist>
            </topicmap>