doc/developer/HotspotStatusXMLSchemaDefinition

Introduction

This article describes the design motivations behind the XML hotspots status feed generated by the Wifidog authentication server. All the data elements and their semantic will thoroughly discussed here. Please note that an XML document containing all data elements is provided in Appendix A of the article.

General technical considerations

You should note that the XML document is entirely generated in UTF-8 encoding, so make you're using multibyte-compatible string manipulation functions (collation, comparison, truncation etc.) when processing the elements values.

Description of all data elements

  • To be done soon.
    • Test

Appendix A

<?xml version="1.0" encoding="UTF-8"?>
<wifidogHotspotsStatus version="1.0">
  <generationDateTime>2006-07-10T09:07:48Z</generationDateTime>
  <networkMetadata>
    <networkUri>http://www.ilesansfil.org</networkUri>
    <name>Île Sans Fil</name>
    <websiteUrl>http://www.ilesansfil.org</websiteUrl>
    <hotspotsCount>104</hotspotsCount>
    <validSubscribedUsersCount>20127</validSubscribedUsersCount>
    <onlineUsersCount>58</onlineUsersCount>
  </networkMetadata>
  <hotspots>
    <hotspot>
      <hotspotId>54</hotspotId>
      <name>Antenne Laïka</name>
      <nodes>
        <node>
          <nodeId>54</nodeId>
          <creationDate>2005-04-09</creationDate>
          <status>up</status>
          <gisLatLong lat="45.521510" long="73.34443"/>
        </node>
      </nodes>
      <openingDate>2005-04-09</openingDate>
      <globalStatus>100</globalStatus>
      <description>Antenne Laïka</description>
      <massTransitInfo>Métro Sherbrooke </massTransitInfo>
      <contactPhoneNumber>514-842-8088</contactPhoneNumber>
      <streetAddress>Entrée du 4040 St-Laurent (coin Duluth)</streetAddress>
      <city>Montréal</city>
      <province>Québec</province>
      <country>Canada</country>
      <gisCenterLatLong lat="" long=""/>
    </hotspot>
    <hotspot>
      <hotspotId>117</hotspotId>
      <name>Arts Café</name>
      <nodes>
        <node>
          <nodeId>117</nodeId>
          <creationDate>2006-06-15</creationDate>
          <status>up</status>
          <gisLatLong lat="45.521510" long="-73.596790"/>
        </node>
      </nodes>
      <openingDate>2006-06-15</openingDate>
      <globalStatus>100</globalStatus>
      <massTransitInfo>Métro Laurier+Bus 51 O. ou Métro Parc+80 S.</massTransitInfo>
      <contactPhoneNumber>514-274-0919</contactPhoneNumber>
      <civicNumber>201</civicNumber>
      <streetAddress>Fairmount O.</streetAddress>
      <city>Montréal</city>
      <province>Qc</province>
      <postalCode>H2T 2M8</postalCode>
      <country>Canada</country>
      <gisCenterLatLong lat="45.521510" long="-73.596790"/>
    </hotspot>
  <hotspots>
</wifidogHotspotsStatus>