git_bsmd/nsw/Source/bsmd.herberg.FormService/Service References/ServiceReferenceHerberg/WSAPIFormData.wsdl
2015-03-29 13:31:25 +00:00

289 lines
13 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:apml="http://www.herbergEngineering.com/apml" xmlns:api="http://www.fleettracker.de/api/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://www.fleettracker.de/api/1.0" targetNamespace="http://www.fleettracker.de/api/1.0" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<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 minOccurs="0" maxOccurs="1" name="startDate" type="xsd:dateTime" />
<xsd:element minOccurs="0" maxOccurs="1" name="endDate" type="xsd:dateTime" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="FormDataInfoDataset">
<xsd:sequence>
<xsd:element minOccurs="1" maxOccurs="1" name="folderTemplateGuid" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The GUID of the folder template
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="formTemplateGuid" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The GUID of the form template
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="folderGuid" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The GUID of the folder</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="formGuid" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The GUID of the form</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="imoNumber" type="xsd:int">
<xsd:annotation>
<xsd:documentation>The IMO number this form belongs to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="lastRevisionDate" type="xsd:dateTime">
<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 minOccurs="1" maxOccurs="1" name="value" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The value
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="unit" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The optional unit
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="name" type="xsd:string">
<xsd:annotation>
<xsd:documentation>The widget name this cell belongs to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="widget_id" type="xsd:int">
<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 minOccurs="0" maxOccurs="1" name="rowNo" type="xsd:int">
<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 minOccurs="1" maxOccurs="1" name="revisionDate" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>The date of the revision.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="startPeriod" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>The begin of the period this dataset is valid
for.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="endPeriod" type="xsd:dateTime">
<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 minOccurs="0" maxOccurs="unbounded" name="formData" type="tns:FormData">
<xsd:annotation>
<xsd:documentation>The values.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="GetFormDataInfoListRequestData">
<xsd:sequence>
<xsd:element minOccurs="1" maxOccurs="1" name="apiIdentifier" type="tns:APIIdentifier">
<xsd:annotation>
<xsd:documentation>
The reporting or requesting party.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="timeFrameRequestFilter" type="tns:TimeFrameRequestFilter">
<xsd:annotation>
<xsd:documentation>The optional time frame. If not set then all entries are returned.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="1" name="ffTemplateName" type="xsd:string">
<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 minOccurs="0" maxOccurs="1" name="ffFolderTemplateTypeTag" type="xsd:string">
<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 minOccurs="1" maxOccurs="1" name="request" type="tns:GetFormDataInfoListRequestData">
<xsd:annotation>
<xsd:documentation>The request</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="unbounded" name="formDataInfoDatasets" type="tns:FormDataInfoDataset">
<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 minOccurs="1" maxOccurs="1" name="apiIdentifier" type="tns:APIIdentifier">
<xsd:annotation>
<xsd:documentation>
The reporting or requesting party.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="formGuid" type="xsd:string">
<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 minOccurs="1" maxOccurs="1" name="request" type="tns:GetFormDataRequestData">
<xsd:annotation>
<xsd:documentation>
The request belonging to this response.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="1" maxOccurs="1" name="imoNumber" type="xsd:int">
<xsd:annotation>
<xsd:documentation>The IMO number of the vessel this form belongs
to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="unbounded" name="formDatasets" type="tns:FormDataset">
<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>
<wsdl:message name="GetFormDataInfoListRequest">
<wsdl:part name="body" type="tns:GetFormDataInfoListRequestData" />
</wsdl:message>
<wsdl:message name="GetFormDataInfoListResponse">
<wsdl:part name="body" type="tns:GetFormDataInfoListResponseData" />
</wsdl:message>
<wsdl:message name="GetFormDataRequest">
<wsdl:part name="body" type="tns:GetFormDataRequestData" />
</wsdl:message>
<wsdl:message name="GetFormDataResponse">
<wsdl:part name="body" type="tns:GetFormDataResponseData" />
</wsdl:message>
<wsdl:portType name="WSAPIFormDataPortType">
<wsdl:operation name="GetFormDataInfoList">
<wsdl:input message="tns:GetFormDataInfoListRequest" />
<wsdl:output message="tns:GetFormDataInfoListResponse" />
</wsdl:operation>
<wsdl:operation name="GetFormData">
<wsdl:input message="tns:GetFormDataRequest" />
<wsdl:output message="tns:GetFormDataResponse" />
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="WSAPIFormDataBinding" type="tns:WSAPIFormDataPortType">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="rpc" />
<wsdl:operation name="GetFormDataInfoList">
<soap:operation soapAction="http://www.fleettracker.de/GetFormDataInfoList" style="rpc" />
<wsdl:input>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</wsdl:input>
<wsdl:output>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetFormData">
<soap:operation soapAction="http://www.fleettracker.de/GetFormData" style="rpc" />
<wsdl:input>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</wsdl:input>
<wsdl:output>
<soap:body use="literal" namespace="http://www.fleettracker.de/api/1.0" encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="WSAPIFormData">
<wsdl:port name="WSAPIFormDataPort" binding="tns:WSAPIFormDataBinding">
<soap:address location="http://www.fleettracker.de/api/1.0/WSAPIFormData.php" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>