GetRoutingPointXml |
|
|
|
|
GetRoutingPointXml |
|
|
|
GetRoutingPointXml |
|
|
|
|
GetRoutingPointXml |
|
|
|
Parameters |
AtoBviaCToken |
String |
MakeReadable |
Boolean |
|
Return Value |
This service call is used to obtain XML that contains information about the Routing points available in the current release from the web service.
AtoBviaCToken must contain a valid token obtained from Logging in
If MakeReadable is passed as true then the output XML will contain tabs and CRLF to make it 'readable'. In general you should always pass false here to restrict the size of the return string to a minimum.
You should inspect the Success field of the MethodResult returned. If the Success field is false then the ErrorCode field contains the numeric ErrorCode and the Result field the English translation of the error, else the Result field contains the XML
Example:-
MethodResult aResult = <ServiceInstance>.GetRoutingPointXml("xxxxxxx",false);
The XML returned in the Result field of the MethodResult contains an array of ServiceRoutingPoint, the fields of which are tabulated below:-
Name |
Type |
Explanation |
|---|---|---|
Id |
String |
The numeric Id of this Routing point |
Name |
String |
The name |
AsciiCode |
String |
The 6 character code |
Open |
Boolean |
True is if Open, false if not |
DefaultValue |
Boolean |
The default 'Open' state |
Category |
String |
The Category, can be used to group points together. Values are Control, Canals, Straits, Capes, Passages and Unused |
GroupType |
String |
The GroupType, can be used to group points together. Values are Control, Primary, Advanced, NonUser, Unused |
GeoCat |
String |
The geographical category, can be used to group point together. Values are Control, Canals, Straits, Capes, Passages, Baltic, NorthSea, Scotland, Ireland, EnglishChannel, Atlantic, Caribbean, Medi, IndianOcean, Indonesia, ChinaSea, Japan, Pacific, Seasonal, RioDePlat, CapeCodCanl, ChesapeakeCanal, Aleutians, NorIdreleia and Unused |
Hint |
String |
Remarks about this Routing point |
ShortCode |
String |
The 3 character Primary short code |
Lat |
String |
The Latitude |
Lon |
String |
The Longitude |
ControlCodes |
String |
If this Routing point controls others then a comma delimited list of the codes that this controls. |
In the .NET world the string returned can be used with the class included in the Demo as the source to deserialise. For other languages and information the XSD is shown below:-
<xs:schema id="ArrayOfServiceRoutingPoint" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
<xs:element name="ArrayOfServiceRoutingPoint" msdata:IsDataSet="true" msdata:Locale="en-US">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="ServiceRoutingPoint">
<xs:complexType>
<xs:sequence>
<xs:element name="Id" type="xs:string" minOccurs="0" />
<xs:element name="Name" type="xs:string" minOccurs="0" />
<xs:element name="AsciiCode" type="xs:string" minOccurs="0" />
<xs:element name="Open" type="xs:boolean" minOccurs="0" />
<xs:element name="DefaultValue" type="xs:boolean" minOccurs="0" />
<xs:element name="Category" type="xs:string" minOccurs="0" />
<xs:element name="GroupType" type="xs:string" minOccurs="0" />
<xs:element name="GeoCat" type="xs:string" minOccurs="0" />
<xs:element name="Hint" type="xs:string" minOccurs="0" />
<xs:element name="ShortCode" type="xs:string" minOccurs="0" />
<xs:element name="Lat" type="xs:string" minOccurs="0" />
<xs:element name="Lon" type="xs:string" minOccurs="0" />
<xs:element name="ControlCodes" type="xs:string" minOccurs="0" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
