SurveyApi.xid.xml
3.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?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.xml" local="SLAM/ApiBase.xid.xml" />
<import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/CommonDefs.xid.xml" local="SLAM/Commondefs.xid.xml" />
<import ref="https://xid.location.studio/ILP/SLAM/V1.0.0_alpha/TileDefinitions.xid.xml" local="SLAM/TileDefinitions.xid.xml" />
<namespace name="SLAM">
<using namespace="HPE"/>
<using namespace="Tensor"/>
<!--
*******************************************************
Survey Submission API
*******************************************************
-->
<interface name="Survey">
<comment>Interface for submitting SLAM compliant survey data.</comment>
<operation name="Submit">
<comment>
Interaction submits survey data and outputs submission result and UUID.
</comment>
<input name="input" type="ILP.InputBase" sid="0x1030">
<elem name="survey" multiplicity="1" type="SurveyData"></elem>
</input>
<output name="output" type="ILP.OutputBase" sid="0x1031">
<comment>Survey submission output returns status and UUID of the submitted survey.</comment>
<elem name="id" multiplicity="1" type="Tensor.UUID"/>
</output>
</operation>
<operation name="Download">
<comment>Downloads survey data given id.</comment>
<input name="input" type="ILP.InputBase" sid="0x1032">
<elem name="id" multiplicity="1" type="Tensor.UUID">
<comment>UUID of Survey set.</comment>
</elem>
<elem name="part" multiplicity="1" type="Tensor.int32" default="-1">
<comment>Survey part id of interest. Default value is -1, which will return </comment>
</elem>
</input>
<output name="output" type="ILP.OutputBase" sid="0x1033">
<comment>Survey download output data structure contains a zero or more surveys.</comment>
<elem name="surveys" multiplicity="0..*" type="SurveyData"></elem>
</output>
</operation>
</interface>
</namespace>
</specification>