IlpSubmissionApi.xid.xml 3.12 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 https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
               identity="IlpSubmissionApi.xid">
    <title>ILP Submission API</title>
    <comment>
        This document defines a lightweight Observation Submission API for submitting ILP compatible observation
        data without invoking the full get position operation.   
    </comment>

  <import ref="https://xid.location.studio/Tensor/V1.0.0/ApiBase.xid.xml" local="ApiBase.xid.xml" />
  <import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />

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


        <!-- SubmitInput structure definition.
             Note: all the tags are defined.  These have to
				match CalculateInput tags of the same name.
        -->
        <struct name="PositionInfo" type="InputBase" >
            <comment>Used as ILP.Submission.PositionInfo input.</comment>

            <elem name="state" multiplicity="0..1" type="StateInfo" ord="90">
                <comment>
                    Optional position information.\n
                    At  least one of observations or state is required,
                    otherwise there is insufficient data to process.
                </comment>
            </elem>

            <elem name="encObs" multiplicity="0..1" type="EncodingFormat" default="0" ord="88">
                <comment>
                    Observation set encoding format. Observations may be passed to the service in
                    an encoding format different than that outer wire format.
                </comment>
            </elem>

            <elem name="observations" multiplicity="0..1" type="ObservationSet" encoding ="encObs" ord="89">
                <comment>
                    Optional Set of observation data encoded in the format specified by encObs.\n
                    At  least one of observations or state is required,
                    otherwise there is insufficient data to process.
                </comment>
            </elem>
        </struct>
   
        <!-- 
        *******************************************************
        Observation Submission API
        *******************************************************
        -->
        <interface name="Submission">
            <comment>Interface for submitting data to ILP. </comment>

            <operation name="PositionInfo">
                <comment>
                    Interaction submits position and observation data.\n
					There is no response besides bearer response codes.
                </comment>
                <input name="Input" type="PositionInfo" sid="0x101E"/>
            </operation>
        </interface>
    </namespace>
</specification>