= Collector interface =

==== group_list ====

    Description: This call returns a list of HAMcast groups. The groups in this list are a merged set of groups gathered from all reachable HAMcast nodes.

    URL : /group_list

    Arguments : none

    Query :
{{{
POST /group_list HTTP/1.1
User-Agent: HAMcast Monitoring
Content-Length:0
Content-Type: text/plain; charset=utf-8
}}}

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

<?xml version="1.0" encoding="utf-8"?>
<method>/group_list</method>
<groups>
  <group>ip://239.0.0.2:1234</group>
</groups>
}}}

==== node_list ====

    Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes.

    URL : /node_list

    Arguments : none
    
    Query :
{{{
POST /node_list HTTP/1.1
User-Agent: HAMcast Monitoring
Content-Length:0
Content-Type: text/plain; charset=utf-8
}}}
   
    Response : 
{{{
HTTP/1.1 200 OK
Content-Length: 402
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<method>/node_list</method>
<nodes>
  <node>129.13.214.10</node>
  <node>129.13.214.210</node>
  <node>129.187.143.20</node>
  <node>130.75.73.66</node>
  <node>130.83.244.170</node>
  <node>131.246.112.2</node>
  <node>131.246.112.31</node>
  <node>132.187.230.65</node>
  <node>84.46.89.78</node>
</nodes>
}}}

==== group_data ====

    Description: Returns a list of daemon-id. The list contains the daemon-ids of all reachable HAMcast nodes that joined the given group.

    URL : /group_data

    Arguments : HAMcast group uri

    Query :
{{{
POST /group_data HTTP/1.1
User-Agent: HAMcast Monitoring
Content-Length:26
Content-Type: text/plain; charset=utf-8

arg0=ip://239.0.0.2:1234
}}}

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

<?xml version="1.0" encoding="utf-8"?>
<method>/group_data</method>
<group>
  <name>ip://239.0.0.2:1234</name>
  <member>129.13.214.10</member>
  <member>129.13.214.210</member>
  <member>129.187.143.20</member>
  <member>130.75.73.66</member>
  <member>130.83.244.170</member>
  <member>131.246.112.2</member>
  <member>131.246.112.31</member>
  <member>132.187.230.65</member>
  <member>84.46.89.78</member>
</group>
}}}

==== node_data ====

    Description: Returns detailed interface and group information about a node, interface and groups.
 
    Node: daemon-id, img-flag 
    Interface: interfcae-id, technology, interface-name, interface-address
    Groups: group-name, parent, parent, children

    URL : /node_data

    Arguments : daemon-id

    Query :
{{{
POST /node_data HTTP/1.1
User-Agent: HAMcast Monitoring
Content-Length:20
Content-Type: text/plain; charset=utf-8

arg0=129.13.214.10
}}}

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

<?xml version="1.0" encoding="utf-8"?>
<name>129.13.214.10</name>
<img>false</img>
<interfaces>
  <interface>
    <name>scribe</name>
    <tech>ALM</tech>
    <id>1</id>
    <addr>scribe://31001132311312033110130111220211220021133010133323303030310133321221122203113311</addr>
    <groups>
      <group>
        <name>ip://239.0.0.2:1234</name>
        <parent>scribe://00303033131001320112231003213203131012203111132203012230202101012110210313231210</parent>
        <children>
          <child>scribe://21002321012323310010133022332200330131312130003122221031210122310033231011211301</child>
        </children>
      </group>
    </groups>
  </interface>
</interfaces>
}}}

==== group_tree ====

    Description: Returns a list of edges between nodes for a given group. The edges are directed from source to destination.

    URL : /group_tree

    Arguments : HAMcast group uri
    
    Query :
{{{
POST /group_tree HTTP/1.1
User-Agent: HAMcast Monitoring
Content-Length:26
Content-Type: text/plain; charset=utf-8

arg0=ip://239.0.0.2:1234
}}}
 
    Response : 
{{{
HTTP/1.1 200 OK
Content-Length: 913
Content-Type: text/xml; charset=utf-8

<?xml version="1.0" encoding="utf-8"?>
<method>/group_tree</method>
<name>ip://239.0.0.2:1234</name>
<edges>
  <edge>
    <from>129.13.214.10</from>
    <to>131.246.112.31</to>
  </edge>
  <edge>
    <from>130.75.73.66</from>
    <to>131.246.112.31</to>
  </edge>
  <edge>
    <from>130.75.73.66</from>
    <to>84.46.89.71</to>
  </edge>
  <edge>
    <from>130.75.73.66</from>
    <to>129.13.214.10</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>130.75.73.66</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>129.13.214.210</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>132.187.230.65</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>129.187.143.20</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>129.13.214.10</to>
  </edge>
  <edge>
    <from>130.83.244.170</from>
    <to>131.246.112.2</to>
  </edge>
</edges>
}}}