git_bsmd/nsw/Herberg/schedule.xsd
2015-03-29 13:31:25 +00:00

601 lines
26 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema elementFormDefault="qualified"
attributeFormDefault="unqualified" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:api='http://www.fleettracker.de/api/1.0'
xmlns="http://www.fleettracker.de/api/1.0" targetNamespace="http://www.fleettracker.de/api/1.0">
<xsd:include schemaLocation="position.xsd" />
<xsd:simpleType name="AGENTTYPE">
<xsd:annotation>
<xsd:documentation>
The type of agent.
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="DEFAULT" >
<xsd:annotation>
<xsd:documentation>
This is the default agent, also called the Charterers agent.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="CREWING" >
<xsd:annotation>
<xsd:documentation>
This is the crewing agent.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="PURCHASING" >
<xsd:annotation>
<xsd:documentation>
This is the purchasing agent.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="OWNERS" >
<xsd:annotation>
<xsd:documentation>
This is the owners agent.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="DESTINATION_TYPE">
<xsd:annotation>
<xsd:documentation>
The destination type of the schedule entry.
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="HARBOUR">
<xsd:annotation>
<xsd:documentation>
This is a port where the ship can berth.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="ANCHORAGE">
<xsd:annotation>
<xsd:documentation>
This is an anchorage area.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="DRIFTING">
<xsd:annotation>
<xsd:documentation>
This is a drifting time.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="CANAL">
<xsd:annotation>
<xsd:documentation>
This is a canal that the vessel may pass.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="RANGE">
<xsd:annotation>
<xsd:documentation>
This is a range indicating a general direction.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="DESTINATION_REMARK_TYPE">
<xsd:annotation>
<xsd:documentation>
The type of a remark that may be attached to a schedule entry.
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="UNKNOWN_TYPE" />
<xsd:enumeration value="US_ENOA" />
<xsd:enumeration value="US_ENOD" />
<xsd:enumeration value="SG_EPANS" />
<xsd:enumeration value="USER_REMARK" />
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="DESTINATION_USERREMARK_TYPE">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="UNKNOWN_TYPE" />
<xsd:enumeration value="FOR_ALL_ARRIVALS_OF_ALL_VESSELS">
<xsd:annotation>
<xsd:documentation>
This type is for all future arrivals of all
vessels to the same
destination.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="FOR_ALL_ARRIVALS_OF_THIS_VESSEL">
<xsd:annotation>
<xsd:documentation>
This type is for all future arrivals of the
specified vessel to the
same destination.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="FOR_THIS_DEST_ONLY">
<xsd:annotation>
<xsd:documentation>
This type is for the specified destination only.
</xsd:documentation>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:simpleType name="DESTINATION_REMARK_STATUS">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="UNKNOWN_STATUS" />
<xsd:enumeration value="INITIAL_SENT" />
<xsd:enumeration value="UPDATE_SENT" />
</xsd:restriction>
</xsd:simpleType>
<!-- ######################################################################################### -->
<xsd:complexType name="DESTINATION_REMARK">
<xsd:annotation>
<xsd:documentation>
This is a destination remark. It refers either to
a particular
destination or a fixed object (i.e. a port).
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="date" minOccurs="1" maxOccurs="1"
type='xsd:dateTime'>
<xsd:annotation>
<xsd:documentation>This is the date when the remark was created.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="type" minOccurs="1" maxOccurs="1"
type='DESTINATION_REMARK_TYPE' />
<xsd:element name="status" minOccurs="1" maxOccurs="1"
type='DESTINATION_REMARK_STATUS' />
<xsd:element name="userRemarkType" minOccurs="0"
maxOccurs="1" type='DESTINATION_USERREMARK_TYPE' default="UNKNOWN_TYPE">
<xsd:annotation>
<xsd:documentation>
This is the optional remark type for user
remarks. If the
type is USER_REMARK then this entry defines how the
user remark should be displayed.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="username" minOccurs="0" maxOccurs="1"
type='xsd:string'>
<xsd:annotation>
<xsd:documentation>
This is the optional user name who entered the
remarks.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="message" minOccurs="0" maxOccurs="1"
type='xsd:string'>
<xsd:annotation>
<xsd:documentation>
This is the optional message (the remark).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- #########################################################################################
The agent ######################################################################################### -->
<xsd:complexType name="SCHEDULEELEMENTAGENT">
<xsd:sequence>
<xsd:element name="AGENTID" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This id is given by the Daily Report. This is
NOT the database id.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="AGENTTYPE" type="AGENTTYPE" />
<xsd:element name="AGENTNAME" type="xsd:string" />
<xsd:element name="AGENTCONTACT" type="xsd:string" />
<xsd:element name="AGENTPHONE" type="xsd:string" />
<xsd:element name="AGENTMOBILE" type="xsd:string" />
<xsd:element name="AGENTEMAILADDR" type="xsd:string" />
<xsd:element name="AGENTCONTACT2" type="xsd:string" />
<xsd:element name="AGENTPHONE2" type="xsd:string" />
<xsd:element name="AGENTMOBILE2" type="xsd:string" />
<xsd:element name="AGENTEMAILADDR2" type="xsd:string" />
<xsd:element name="AGENTCONTACT3" type="xsd:string" />
<xsd:element name="AGENTPHONE3" type="xsd:string" />
<xsd:element name="AGENTMOBILE3" type="xsd:string" />
<xsd:element name="AGENTEMAILADDR3" type="xsd:string" />
<xsd:element name="AGENTFAX" type="xsd:string" />
<xsd:element name="AGENTADDRESS1" type="xsd:string" />
<xsd:element name="AGENTADDRESS2" type="xsd:string" />
<xsd:element name="AGENTADDRESS3" type="xsd:string" />
<xsd:element name="AGENTZIP" type="xsd:string" />
<xsd:element name="AGENTCITY" type="xsd:string" />
<xsd:element name="AGENTCOUNTRY" type="xsd:string" />
<xsd:element name="created" minOccurs="0" maxOccurs="1" type='xsd:dateTime'>
<xsd:annotation>
<xsd:documentation>The entry was created at this time
in UTC.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="removed" minOccurs="0" maxOccurs="1" type='xsd:dateTime'>
<xsd:annotation>
<xsd:documentation>The entry was removed at this time
in UTC.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="deprecated" type="xsd:boolean" minOccurs="0" maxOccurs="1" default="false">
<xsd:annotation>
<xsd:documentation>
Indicates that this entry should not be used any more. Added 01/2015.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="agentGuid" type="xsd:string" minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the unique GUID of this entry. Added 01/2015.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- #########################################################################################
The schedule entry ######################################################################################### -->
<xsd:complexType name="SCHEDULEELEMENT">
<xsd:annotation>
<xsd:documentation>
This is a destination remark. It refers either to
a particular
destination or a fixed object (i.e. a port).
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="ELEMENT_ID" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
This is the unique identifier (ident) created by
the Daily Report
tool. for historical reasons, this is
an integer
created based on the time stamp. The id is unique within
the
schedule.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="voyageNumber" type="xsd:string"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional voyage number this
destination belongs to. It is
normally entered on board and is a
number or string.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="HARBOUR" type="xsd:string" >
<xsd:annotation>
<xsd:documentation>
The name of the schedule entry. This may be the port name (e.g. Hamburg), the anchorage name etc.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<!-- The port type -->
<xsd:element name="DEST_TYPE" type="DESTINATION_TYPE"
default="HARBOUR" >
<xsd:annotation>
<xsd:documentation>
The type of this schedule entry.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="STATECODE" type="xsd:string" >
<xsd:annotation>
<xsd:documentation>
The state code (for US ports)
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="UNLOCATIONCODE" type="xsd:string" >
<xsd:annotation>
<xsd:documentation>
The unique UN location code (3 letters, e.g. HAM for Hamburg)
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="COUNTRYCODE" type="xsd:string" >
<xsd:annotation>
<xsd:documentation>
The ISO country code (e.g. DE for Germany, US for USA).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="COUNTRYNAME" type="xsd:string"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional country name.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="DEST_POSITION" type="api:Position"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional geographic position of
the
destination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ETA" type="xsd:dateTime" >
<xsd:annotation>
<xsd:documentation>
The expected time of arrival (local time).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ETD" type="xsd:dateTime" minOccurs="0"
maxOccurs="1" >
<xsd:annotation>
<xsd:documentation>
The expected time of departure (local time).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ETB" type="xsd:dateTime" minOccurs="0"
maxOccurs="1" >
<xsd:annotation>
<xsd:documentation>
The expected time of berth (local time).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="APS" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional arrival at pilot
station (local time).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="FWE" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional Finished with Engine (local time).
Only
if arrived.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="EOSP" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional End of Sea Passage (local time).
Only
if
arrived.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ATB" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional Actual time of Berth (local time).
Only if arrived.
Note: This is deprecated!
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="SBE" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional Stand by Engine (local time).
Only if
departed.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ATD" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional Actual time of
Departure (local time).
Only if departed.
Note: This is deprecated!
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BOSP" type="xsd:dateTime" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the optional Begin of Sea Passage.
Only
if departed.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="ARRIVED" type="xsd:boolean" default="false" >
<xsd:annotation>
<xsd:documentation>
If true, the vessel arrived at the destination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="LEFT" type="xsd:boolean" default="false" >
<xsd:annotation>
<xsd:documentation>
If true, the vessel departed from the destination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="CANCELED" type="xsd:boolean" default="false" >
<xsd:annotation>
<xsd:documentation>
If true, this destination was canceled.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="COMMENT" type="xsd:string" >
<xsd:annotation>
<xsd:documentation>
Some remarks by the author responsible for the schedule.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="PORT_ACTIVITIES" minOccurs="0"
maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
The port activity. This may be a set of the
following operations.
</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="LOADING">
</xsd:enumeration>
<xsd:enumeration value="DISCHARGING">
</xsd:enumeration>
<xsd:enumeration value="BUNKERING">
</xsd:enumeration>
<xsd:enumeration value="AWAITING_SERVICE">
</xsd:enumeration>
<xsd:enumeration value="FOR_REPAIRS">
</xsd:enumeration>
<xsd:enumeration value="SHIPYARD">
</xsd:enumeration>
<xsd:enumeration value="FOR_ORDERS">
</xsd:enumeration>
<xsd:enumeration value="PURGING">
</xsd:enumeration>
<xsd:enumeration value="CLEANING">
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="PORT_CALL_NOT_FIXED_YET" type="xsd:boolean"
default="false" minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This optional value indicates that the
destination is preliminary.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="AGENT" type="SCHEDULEELEMENTAGENT"
minOccurs="0" maxOccurs="4" >
<xsd:annotation>
<xsd:documentation>
The agents responsible for the vessel at the destination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="unbounded"
name="DESTINATION_REMARKS" type="DESTINATION_REMARK" >
<xsd:annotation>
<xsd:documentation>
A set of remarks related to the destination.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- #########################################################################################
The schedule ######################################################################################### -->
<xsd:complexType name="SCHEDULE">
<xsd:sequence>
<xsd:element name="SCHEDULE_ID" type="xsd:unsignedInt" >
<xsd:annotation>
<xsd:documentation>
An identifier for the schedule (not the database id). Note that several vessels may have schedules with identical SCHEDULE_IDs.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="changed" type="xsd:dateTime"
minOccurs="0" maxOccurs="1" >
<xsd:annotation>
<xsd:documentation>
Last modification time of the schedule.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="author" type="xsd:string" minOccurs="0"
maxOccurs="1">
<xsd:annotation>
<xsd:documentation>
This is the author, normally the captains name.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="chiefname" type="xsd:string"
minOccurs="0" maxOccurs="1" >
<xsd:annotation>
<xsd:documentation>
This is the optional chief engineers name.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="chiefOfficerName" type="xsd:string"
minOccurs="0" maxOccurs="1">
<xsd:annotation>
<xsd:documentation>optional Chief officer name</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" maxOccurs="unbounded" name="ELEMENT"
type="SCHEDULEELEMENT">
<xsd:annotation>
<xsd:documentation>
The destinations of this schedule. These are the schedule entries.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>