Main Index MAIN
INDEX
Search Posts SEARCH
POSTS
Who's Online WHO'S
ONLINE
Log in LOG
IN
Dansk Dansk

Home: Slashdemocracy: WS4LSQL:
Documentation

 

 


gotze
Site administrator / Moderator

Sep 28, 2004, 1:39 PM

Post #1 of 1 (2083 views)
Shortcut
Documentation Can't Post

WS4LSQL is badly in need of some documentation.

I'm implementing a real-life webservice for a customised LSQL-based site, and will need to make some documentation for this service.

For the developers out there, check this SOAPscope service:
http://mindreef.net/...rk.info/ws4lsql.wsdl


WS4RP - Webservices for the Reference Profile
------------------------------------------------

WS4RP is a full-blown, standards-compliant* webservice that allows anyone to integrate the full content of the Reference Profile into other applications and/or services.
bla bla bla

Service info
The WDSL file: http://interoperabilityframework.info/ws4lsql.wsdl Service: WS4lsqlService
Port: WS4lsqlPort
PortType: WS4lsqlPortType
Bindings via the document literal method.
The service can invoke two methods ("subservices"?):
doLinksSearch
GetTenNewestLinksRequest


Send messages in doLinksSearch
-------------------------------

query = Search term
catid = category ID. Limit searches to a certain category. For exampple '1' for User Interfaces.
bool = boolean searches. value 'and' or 'or'; and: Results must contain all words; or:Results can contain any of the words
substring = substring search. value 0 or 1
nh = next hits. For example mh=10&nh=2 for hits number 11-20.
mh = max hits. 10, 25, 50 or 100. (you get a link_hits back with total number of hits)
so = search order. asc or desc (ascending or descending)
sb = sort by. ID, etc.
ID = the internal ID number for a given standard.
URL = The reference link for a given standard
Add_Date = Date added
Mod_Date = Date modified
Contact_Name = Name of contact person
Contact_Email = Email adress for contact person
isNew = "Yes" if recently added
isChanged = "Yes" if recently modified
isPopular = "Yes" if link is popular
Rating = Users' rating avarage, x.xx
Votes = Number of votes
Date_Checked = System date
Betegnelse = Acronym used for this standard
StatusAssessment = The status assessment for this standard (Forlad, Opretholdt, Kommende, De Facto, Godkendt, Anbefalet)
Multilang_Dansk_Title = Danish heading for this standard
Multilang_Dansk_Description = Danish description of this standard (often in HTML)
Multilang_English_Title = English heading for this standard
Multilang_English_Description = English description of this standard (often in HTML)



Return messages in doLinksSearch (doLinkSearchResponse)
---------------------------------

LinksResults = List of found standards
CategoryResults = List of found categories
link_hits = Number of found standards
category_hits = Number of found categories
mh = max hits. 10, 25, 50 or 100.


XML Schema
------------
This schema will be validated for OIO compliance.


<xsd:schema elementFormDefault="qualified"
targetNamespace="http://interoperabilityframework.info/WS4LsqlSL">
<xsd:element name="doLinksSearch">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="query" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="catid" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="bool" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="substring" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="nh" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="mh" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="so" type="xsd:string" minOccurs="0" maxOccurs="1"/><!-- asc, des -->
<xsd:element name="sb" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="ID" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="URL" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Add_Date" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Mod_Date" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Contact_Name" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Contact_Email" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="isNew" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="isChanged" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="isPopular" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Rating" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Votes" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Date_Checked" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Betegnelse" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="StatusAssessment" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Title" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Description" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_English_Title" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_English_Description" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_test_Title" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="Multilang_test_Description" type="xsd:string" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

<!-- for search result -->
<xsd:element name="doLinkSearchResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="doLinkSearchResult" type="tns:WS4lsqlSearchResults"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>

<xsd:complexType name="WS4lsqlSearchResults">
<xsd:sequence>
<xsd:element name="LinksResults" type="tns:LinkElementArray" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="CategoryResults" type="tns:CategoryElementArray" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="link_hits" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="category_hits" type="xsd:int" minOccurs="0" maxOccurs="1"/>
<xsd:element name="mh" type="xsd:int" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>

<xsd:complexType name="LinkElementArray">
<xsd:sequence>
<xsd:element name="ID" type="xsd:int" minOccurs="1" maxOccurs="1"/>
<xsd:element name="URL" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Add_Date" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Mod_Date" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="isNew" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Rating" type="xsd:float" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Votes" type="xsd:int" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Betegnelse" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="StatusAssessment" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Title" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_English_Title" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_English_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_test_Title" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_test_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>


<xsd:complexType name="CategoryElementArray">
<xsd:sequence>
<xsd:element name="title_linked" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="ID" type="xsd:int" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Full_Name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Meta_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Meta_Keywords" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Header" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Footer" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Number_of_Links" type="xsd:int" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Has_New_Links" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Has_Changed_Links" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Newest_Link" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_Dansk_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_English_Name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_English_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Politikker" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="MereInfo" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_test_Name" type="xsd:string" minOccurs="1" maxOccurs="1"/>
<xsd:element name="Multilang_test_Description" type="xsd:string" minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>

 
 
 


Search for (options) Powered by Gossamer Forum v.1.2.4