SurveyApi.xid.xml 2.8 KB
<?xml version="1.0" encoding="UTF-8" ?>

<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
               xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd XtensibleInterfaceDefinition.xsd"
               identity="SurveyApi.xid.xml">
  <title>SLAM Survey API Specifications</title>
  <comment>
    This file defines the SLAM survey API.  The survey API is used to bulk load high-definition survey
    data from one or more probe data sets.
  </comment>

  <!-- Include all known definitions -->
  <import ref="https://xid.location.studio/Tensor/V1.0.0/Definitions.xid.xml" local="Definitions.xid.xml" />
  <import ref="https://xid.location.studio/HPE/V1.1.1/HpeCore.xid.xml" local="HpeCore.xid.xml" />
  <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeGnss.xid.xml" local="HpeGnss.xid.xml" />
  <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeCellular.xid.xml" local="HpeCellular.xid.xml" />
  <import ref="https://xid.location.studio/HPE/CommonDefs/V1.1.1/HpeWiFi.xid.xml" local="HpeWiFi.xid.xml" />
  <import ref="https://xid.location.studio/ILP/V1.1.1/ApiBase.xid" local="SLAM/ApiBase.xid" />
  <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/CommonDefs.xid" local="SLAM/Commondefs.xid.xml" />
  <import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid" local="SLAM/TileDefinitions.xid.xml" />

  <namespace name="SLAM">
    <using namespace="HPE"/>
    <using namespace="Tensor"/>


    <!-- 
    *******************************************************
    Survey Submission API
    *******************************************************
    -->
    <interface name="Survey">
      <comment>Interface for submitting data to ILP. </comment>

      <operation name="Submit">
        <comment>
          Interaction submits Survey data.
        </comment>
        <input name="input" type="InputBase"  sid="0x1030">
          <elem name="survey" multiplicity="1" type="SurveyData"></elem>
        </input>
        <output name="output" type="OutputBase" sid="0x1031">
          <elem name="id" multiplicity="1" type="Tensor.UUID"/>
        </output>
      </operation>

      <operation name="Download">
        <comment>Downloads survey data given id.</comment>
        <input name="input" type="InputBase"  sid="0x1032">
          <elem name="id" multiplicity="1" type="Tensor.UUID"/>
        </input>
        <output name="output" type="OutputBase" sid="0x1033">
          <elem name="survey" multiplicity="1" type="SurveyData"></elem>
        </output>
      </operation>
    </interface>

  </namespace>
</specification>