git_bsmd/nsw/Herberg/WSAPIFormData.wsdl
2015-03-29 13:31:25 +00:00

365 lines
14 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<definitions xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://www.fleettracker.de/api/1.0"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:apml="http://www.herbergEngineering.com/apml" xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:api='http://www.fleettracker.de/api/1.0' targetNamespace="http://www.fleettracker.de/api/1.0">
<wsdl:types>
<xsd:schema targetNamespace="http://www.fleettracker.de/api/1.0">
<xsd:import namespace="http://schemas.xmlsoap.org/soap/encoding/" />
<xsd:import namespace="http://schemas.xmlsoap.org/wsdl/" />
<xsd:include schemaLocation="position.xsd" />
<xsd:include schemaLocation="device.xsd" />
<xsd:include schemaLocation="auth.xsd" />
<xsd:include schemaLocation="geoarea.xsd" />
<xsd:include schemaLocation="shipParams.xsd" />
<xsd:include schemaLocation="target.xsd" />
<xsd:include schemaLocation="ship.xsd" />
<!-- ####################################################################### -->
<!-- ####################################################################### -->
<xsd:complexType name="TimeFrameRequestFilter">
<xsd:sequence>
<xsd:element name="startDate" type="xsd:dateTime"
minOccurs="0" maxOccurs="1" />
<xsd:element name="endDate" type="xsd:dateTime"
minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<xsd:complexType name="FormDataInfoDataset">
<xsd:sequence>
<xsd:element name="folderTemplateGuid" type="xsd:string"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The GUID of the folder template
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formTemplateGuid" type="xsd:string"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The GUID of the form template
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="folderGuid" type="xsd:string"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The GUID of the folder</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formGuid" type="xsd:string"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The GUID of the form</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="imoNumber" type="xsd:int" minOccurs="1"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The IMO number this form belongs to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="lastRevisionDate" type="xsd:dateTime"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The date of the latest revision.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<xsd:complexType name="FormData">
<xsd:sequence>
<xsd:element name="value" type="xsd:string" minOccurs="1"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The value
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="unit" type="xsd:string" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The optional unit
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="xsd:string" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The widget name this cell belongs to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="widget_id" type="xsd:int" minOccurs="1"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The widget id the value belongs to. Note
that this entry is the id within the form template but NOT the database id of the widget!
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="rowNo" type="xsd:int" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The optional row number. This is set if we
have a widget that is part of a table.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<xsd:complexType name="FormDataset">
<xsd:sequence>
<xsd:element name="revisionDate" type="xsd:dateTime"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The date of the revision.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="startPeriod" type="xsd:dateTime"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The begin of the period this dataset is valid
for.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="endPeriod" type="xsd:dateTime"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The end of the period this row is valid for.
If startPeriod is not given, the endPeriod contains the sample
timestamp.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formData" type="tns:FormData"
minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>The values.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<!-- ####################################################################### -->
<xsd:complexType name="GetFormDataInfoListRequestData">
<xsd:sequence>
<xsd:element name="apiIdentifier" type="api:APIIdentifier"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
The reporting or requesting party.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="timeFrameRequestFilter" type="tns:TimeFrameRequestFilter"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The optional time frame. If not set then all entries are returned.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ffTemplateName" type="xsd:string"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>This is the Fleetform form template name (see
FolderTemplate.Template.TemplateName).
You have to either set
this or ffFolderTemplateTypeTag.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ffFolderTemplateTypeTag" type="xsd:string"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>This is the Fleetform folder template typeTag,
e.g. CREWLIST, PERFORMANCEREPORT, SHIPDETAILS, etc. See
FolderTemplate in fleetform.xsd
for possible values.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<xsd:complexType name="GetFormDataInfoListResponseData">
<xsd:sequence>
<xsd:element name="request" type="tns:GetFormDataInfoListRequestData"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The request</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formDataInfoDatasets" type="tns:FormDataInfoDataset"
minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>A set of form data found in the database.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="result" type="xsd:string" />
<xsd:element name="success" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>This flag is set to true if the route was
successfully stored.
Otherwise, result contains the error
message.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<!-- ####################################################################### -->
<xsd:complexType name="GetFormDataRequestData">
<xsd:sequence>
<xsd:element name="apiIdentifier" type="api:APIIdentifier"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
The reporting or requesting party.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formGuid" type="xsd:string"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The GUID of the form.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
<xsd:complexType name="GetFormDataResponseData">
<xsd:sequence>
<xsd:element name="request" type="tns:GetFormDataRequestData"
minOccurs="1" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
The request belonging to this response.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="imoNumber" type="xsd:int" minOccurs="1"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>The IMO number of the vessel this form belongs
to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="formDatasets" type="tns:FormDataset"
minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
The requested data. If not found then this
entry is null. Note that we may have several entries for one
form here since one form may contain several entries.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="result" type="xsd:string" />
<xsd:element name="success" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
This flag is set to true if the route was
successfully stored.
Otherwise, result contains the error
message.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- ####################################################################### -->
</xsd:schema>
</wsdl:types>
<!-- ####################################################################### -->
<!-- ####################################################################### -->
<message name="GetFormDataInfoListRequest">
<part name="body" type="tns:GetFormDataInfoListRequestData" />
</message>
<message name="GetFormDataInfoListResponse">
<part name="body" type="tns:GetFormDataInfoListResponseData" />
</message>
<message name="GetFormDataRequest">
<part name="body" type="tns:GetFormDataRequestData" />
</message>
<message name="GetFormDataResponse">
<part name="body" type="tns:GetFormDataResponseData" />
</message>
<!-- ####################################################################### -->
<!-- ########################################################### -->
<portType name="WSAPIFormDataPortType">
<operation name="GetFormDataInfoList">
<input message="tns:GetFormDataInfoListRequest" />
<output message="tns:GetFormDataInfoListResponse" />
</operation>
<operation name="GetFormData">
<input message="tns:GetFormDataRequest" />
<output message="tns:GetFormDataResponse" />
</operation>
</portType>
<!-- ########################################################### -->
<binding name="WSAPIFormDataBinding" type="tns:WSAPIFormDataPortType">
<soap:binding style="rpc"
transport="http://schemas.xmlsoap.org/soap/http" />
<operation name="GetFormDataInfoList">
<soap:operation soapAction="http://www.fleettracker.de/GetFormDataInfoList"
style="rpc" />
<input>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</input>
<output>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</output>
</operation>
<operation name="GetFormData">
<soap:operation soapAction="http://www.fleettracker.de/GetFormData"
style="rpc" />
<input>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</input>
<output>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0"
encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</output>
</operation>
</binding>
<!-- ########################################################### -->
<service name="WSAPIFormData">
<port name="WSAPIFormDataPort" binding="tns:WSAPIFormDataBinding">
<soap:address location="http://www.fleettracker.de/api/1.0/WSAPIFormData.php" />
</port>
</service>
</definitions>