Skip to content

xid / specs

Go to a project
Toggle navigation
Toggle navigation pinning
209d067d by Michael B. Mathews
Options

Updated SLAM SurveyAPI

1 parent 3fb6b6b3
Inline Side-by-side
Showing 2 changed files with 19 additions and 13 deletions
ILP/SLAM/V1.0.0_alpha/CommonDefs.xid.xml
...@@ -93,10 +93,10 @@ ...@@ -93,10 +93,10 @@
93 </elem> 93 </elem>
94 94
95 <elem name="email" multiplicity ="1" type="string" > 95 <elem name="email" multiplicity ="1" type="string" >
96 <comment>Contact email addres. Default is empty.</comment> 96 <comment>Contact email address.</comment>
97 </elem> 97 </elem>
98 <elem name="phone" multiplicity ="1" type="string" > 98 <elem name="phone" multiplicity ="1" type="string" >
99 <comment>Contact phone number. Default is empty.</comment> 99 <comment>Contact phone number.</comment>
100 </elem> 100 </elem>
101 </struct> 101 </struct>
102 102
...@@ -107,22 +107,22 @@ ...@@ -107,22 +107,22 @@
107 --> 107 -->
108 <struct name="AddressInfo"> 108 <struct name="AddressInfo">
109 <elem name="address1" multiplicity ="1" type="string"> 109 <elem name="address1" multiplicity ="1" type="string">
110 <comment>First line street address. Default is empty.</comment> 110 <comment>First line street address.</comment>
111 </elem> 111 </elem>
112 <elem name="address2" multiplicity ="1" type="string"> 112 <elem name="address2" multiplicity ="0..1" type="string">
113 <comment>Second line street address. Default is empty.</comment> 113 <comment>Second line street address.</comment>
114 </elem> 114 </elem>
115 <elem name="City" multiplicity ="1" type="string"> 115 <elem name="City" multiplicity ="1" type="string">
116 <comment>Name of City. Default is empty.</comment> 116 <comment>Name of City.</comment>
117 </elem> 117 </elem>
118 <elem name="StateRegion" multiplicity ="1" type="string"> 118 <elem name="StateRegion" multiplicity ="1" type="string">
119 <comment>State or region. Two character state definitions ok for U.S. addresses. Default is empty.</comment> 119 <comment>State or region. Two character state definitions ok for U.S. addresses. Default is empty.</comment>
120 </elem> 120 </elem>
121 <elem name="PostalCode" multiplicity ="1" type="string"> 121 <elem name="PostalCode" multiplicity ="1" type="string">
122 <comment>Postal code or zip code. Default is empty.</comment> 122 <comment>Postal code or zip code.</comment>
123 </elem> 123 </elem>
124 <elem name="Country" multiplicity ="1" type="string"> 124 <elem name="Country" multiplicity ="1" type="string">
125 <comment>Name of the country. Default is empty.</comment> 125 <comment>Name of the country.</comment>
126 </elem> 126 </elem>
127 127
128 </struct> 128 </struct>
......
ILP/SLAM/V1.0.0_alpha/SurveyApi.xid.xml
...@@ -25,23 +25,23 @@ ...@@ -25,23 +25,23 @@
25 <using namespace="HPE"/> 25 <using namespace="HPE"/>
26 <using namespace="Tensor"/> 26 <using namespace="Tensor"/>
27 27
28
29 <!-- 28 <!--
30 ******************************************************* 29 *******************************************************
31 Survey Submission API 30 Survey Submission API
32 ******************************************************* 31 *******************************************************
33 --> 32 -->
34 <interface name="Survey"> 33 <interface name="Survey">
35 <comment>Interface for submitting data to ILP. </comment> 34 <comment>Interface for submitting SLAM compliant survey data.</comment>
36 35
37 <operation name="Submit"> 36 <operation name="Submit">
38 <comment> 37 <comment>
39 Interaction submits Survey data. 38 Interaction submits survey data and outputs submission result and UUID.
40 </comment> 39 </comment>
41 <input name="input" type="ILP.InputBase" sid="0x1030"> 40 <input name="input" type="ILP.InputBase" sid="0x1030">
42 <elem name="survey" multiplicity="1" type="SurveyData"></elem> 41 <elem name="survey" multiplicity="1" type="SurveyData"></elem>
43 </input> 42 </input>
44 <output name="output" type="ILP.OutputBase" sid="0x1031"> 43 <output name="output" type="ILP.OutputBase" sid="0x1031">
44 <comment>Survey submission output returns status and UUID of the submitted survey.</comment>
45 <elem name="id" multiplicity="1" type="Tensor.UUID"/> 45 <elem name="id" multiplicity="1" type="Tensor.UUID"/>
46 </output> 46 </output>
47 </operation> 47 </operation>
...@@ -49,10 +49,16 @@ ...@@ -49,10 +49,16 @@
49 <operation name="Download"> 49 <operation name="Download">
50 <comment>Downloads survey data given id.</comment> 50 <comment>Downloads survey data given id.</comment>
51 <input name="input" type="ILP.InputBase" sid="0x1032"> 51 <input name="input" type="ILP.InputBase" sid="0x1032">
52 <elem name="id" multiplicity="1" type="Tensor.UUID"/> 52 <elem name="id" multiplicity="1" type="Tensor.UUID">
53 <comment>UUID of Survey set.</comment>
54 </elem>
55 <elem name="part" multiplicity="1" type="Tensor.int32" default="-1">
56 <comment>Survey part id of interest. Default value is -1, which will return </comment>
57 </elem>
53 </input> 58 </input>
54 <output name="output" type="ILP.OutputBase" sid="0x1033"> 59 <output name="output" type="ILP.OutputBase" sid="0x1033">
55 <elem name="survey" multiplicity="1" type="SurveyData"></elem> 60 <comment>Survey download output data structure contains a zero or more surveys.</comment>
61 <elem name="surveys" multiplicity="0..*" type="SurveyData"></elem>
56 </output> 62 </output>
57 </operation> 63 </operation>
58 </interface> 64 </interface>
......
Styling with Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!