UNPKG

ws-dottie

Version:

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

354 lines 18.7 kB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Reference for http://www.wsdot.wa.gov/Ferries/API/Schedule/rest/scheduletoday/{DEPARTINGTERMINALID}/{ARRIVINGTERMINALID}/{ONLYREMAININGTIMES}?apiaccesscode={APIACCESSCODE}</title> <style>BODY { color: #000000; background-color: white; font-family: Verdana; margin-left: 0px; margin-top: 0px; } #content { margin-left: 30px; font-size: .70em; padding-bottom: 2em; } A:link { color: #336699; font-weight: bold; text-decoration: underline; } A:visited { color: #6699cc; font-weight: bold; text-decoration: underline; } A:active { color: #336699; font-weight: bold; text-decoration: underline; } .heading1 { background-color: #003366; border-bottom: #336699 6px solid; color: #ffffff; font-family: Tahoma; font-size: 26px; font-weight: normal;margin: 0em 0em 10px -20px; padding-bottom: 8px; padding-left: 30px;padding-top: 16px;} pre { font-size:small; background-color: #e5e5cc; padding: 5px; font-family: Courier New; margin-top: 0px; border: 1px #f0f0e0 solid; white-space: pre-wrap; white-space: -pre-wrap; word-wrap: break-word; } table { border-collapse: collapse; border-spacing: 0px; font-family: Verdana;} table th { border-right: 2px white solid; border-bottom: 2px white solid; font-weight: bold; background-color: #cecf9c;} table td { border-right: 2px white solid; border-bottom: 2px white solid; background-color: #e5e5cc;}</style> </head> <body> <div id="content"> <p class="heading1">Reference for http://www.wsdot.wa.gov/Ferries/API/Schedule/rest/scheduletoday/{DEPARTINGTERMINALID}/{ARRIVINGTERMINALID}/{ONLYREMAININGTIMES}?apiaccesscode={APIACCESSCODE}</p> <p></p> <p xmlns="http://www.w3.org/1999/xhtml"> <b>Url: </b> <span class="uri-template">http://www.wsdot.wa.gov/Ferries/API/Schedule/rest/scheduletoday/{DEPARTINGTERMINALID}/{ARRIVINGTERMINALID}/{ONLYREMAININGTIMES}?apiaccesscode={APIACCESSCODE}</span> </p> <p xmlns="http://www.w3.org/1999/xhtml"> <b>HTTP Method: </b> <span class="method">GET</span> </p> <p xmlns="http://www.w3.org/1999/xhtml">This operation supports JSONP responses. The callback function can be specified using the <b>"<span class="javascript-callback">callback</span>"</b> Url query parameter.</p> <table> <tr> <th>Message direction</th> <th>Format</th> <th>Body</th> </tr> <tr> <td>Request</td> <td>N/A</td> <td>The Request body is empty.</td> </tr> <tr> <td>Response</td> <td>Xml</td> <td> <a href="#response-xml">Example</a>,<a href="#response-schema">Schema</a></td> </tr> <tr> <td>Response</td> <td>Json</td> <td> <a href="#response-json">Example</a> </td> </tr> </table> <p> <a name="response-xml">The following is an example response Xml body:</a> <pre class="response-xml">&lt;SchedResponse xmlns="http://www.wsdot.wa.gov/ferries/schedule/"&gt; &lt;ScheduleID&gt;2147483647&lt;/ScheduleID&gt; &lt;ScheduleName&gt;String content&lt;/ScheduleName&gt; &lt;ScheduleSeason&gt;Spring&lt;/ScheduleSeason&gt; &lt;SchedulePDFUrl&gt;String content&lt;/SchedulePDFUrl&gt; &lt;ScheduleStart&gt;1999-05-31T11:20:00&lt;/ScheduleStart&gt; &lt;ScheduleEnd&gt;1999-05-31T11:20:00&lt;/ScheduleEnd&gt; &lt;AllRoutes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AllRoutes&gt; &lt;TerminalCombos&gt; &lt;SchedTerminalCombo&gt; &lt;DepartingTerminalID&gt;2147483647&lt;/DepartingTerminalID&gt; &lt;DepartingTerminalName&gt;String content&lt;/DepartingTerminalName&gt; &lt;ArrivingTerminalID&gt;2147483647&lt;/ArrivingTerminalID&gt; &lt;ArrivingTerminalName&gt;String content&lt;/ArrivingTerminalName&gt; &lt;SailingNotes&gt;String content&lt;/SailingNotes&gt; &lt;Annotations&gt; &lt;string&gt;String content&lt;/string&gt; &lt;string&gt;String content&lt;/string&gt; &lt;/Annotations&gt; &lt;Times&gt; &lt;SchedTime&gt; &lt;DepartingTime&gt;1999-05-31T11:20:00&lt;/DepartingTime&gt; &lt;ArrivingTime&gt;1999-05-31T11:20:00&lt;/ArrivingTime&gt; &lt;LoadingRule&gt;Passenger&lt;/LoadingRule&gt; &lt;VesselID&gt;2147483647&lt;/VesselID&gt; &lt;VesselName&gt;String content&lt;/VesselName&gt; &lt;VesselHandicapAccessible&gt;true&lt;/VesselHandicapAccessible&gt; &lt;VesselPositionNum&gt;2147483647&lt;/VesselPositionNum&gt; &lt;Routes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/Routes&gt; &lt;AnnotationIndexes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AnnotationIndexes&gt; &lt;/SchedTime&gt; &lt;SchedTime&gt; &lt;DepartingTime&gt;1999-05-31T11:20:00&lt;/DepartingTime&gt; &lt;ArrivingTime&gt;1999-05-31T11:20:00&lt;/ArrivingTime&gt; &lt;LoadingRule&gt;Passenger&lt;/LoadingRule&gt; &lt;VesselID&gt;2147483647&lt;/VesselID&gt; &lt;VesselName&gt;String content&lt;/VesselName&gt; &lt;VesselHandicapAccessible&gt;true&lt;/VesselHandicapAccessible&gt; &lt;VesselPositionNum&gt;2147483647&lt;/VesselPositionNum&gt; &lt;Routes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/Routes&gt; &lt;AnnotationIndexes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AnnotationIndexes&gt; &lt;/SchedTime&gt; &lt;/Times&gt; &lt;AnnotationsIVR&gt; &lt;string&gt;String content&lt;/string&gt; &lt;string&gt;String content&lt;/string&gt; &lt;/AnnotationsIVR&gt; &lt;/SchedTerminalCombo&gt; &lt;SchedTerminalCombo&gt; &lt;DepartingTerminalID&gt;2147483647&lt;/DepartingTerminalID&gt; &lt;DepartingTerminalName&gt;String content&lt;/DepartingTerminalName&gt; &lt;ArrivingTerminalID&gt;2147483647&lt;/ArrivingTerminalID&gt; &lt;ArrivingTerminalName&gt;String content&lt;/ArrivingTerminalName&gt; &lt;SailingNotes&gt;String content&lt;/SailingNotes&gt; &lt;Annotations&gt; &lt;string&gt;String content&lt;/string&gt; &lt;string&gt;String content&lt;/string&gt; &lt;/Annotations&gt; &lt;Times&gt; &lt;SchedTime&gt; &lt;DepartingTime&gt;1999-05-31T11:20:00&lt;/DepartingTime&gt; &lt;ArrivingTime&gt;1999-05-31T11:20:00&lt;/ArrivingTime&gt; &lt;LoadingRule&gt;Passenger&lt;/LoadingRule&gt; &lt;VesselID&gt;2147483647&lt;/VesselID&gt; &lt;VesselName&gt;String content&lt;/VesselName&gt; &lt;VesselHandicapAccessible&gt;true&lt;/VesselHandicapAccessible&gt; &lt;VesselPositionNum&gt;2147483647&lt;/VesselPositionNum&gt; &lt;Routes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/Routes&gt; &lt;AnnotationIndexes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AnnotationIndexes&gt; &lt;/SchedTime&gt; &lt;SchedTime&gt; &lt;DepartingTime&gt;1999-05-31T11:20:00&lt;/DepartingTime&gt; &lt;ArrivingTime&gt;1999-05-31T11:20:00&lt;/ArrivingTime&gt; &lt;LoadingRule&gt;Passenger&lt;/LoadingRule&gt; &lt;VesselID&gt;2147483647&lt;/VesselID&gt; &lt;VesselName&gt;String content&lt;/VesselName&gt; &lt;VesselHandicapAccessible&gt;true&lt;/VesselHandicapAccessible&gt; &lt;VesselPositionNum&gt;2147483647&lt;/VesselPositionNum&gt; &lt;Routes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/Routes&gt; &lt;AnnotationIndexes&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AnnotationIndexes&gt; &lt;/SchedTime&gt; &lt;/Times&gt; &lt;AnnotationsIVR&gt; &lt;string&gt;String content&lt;/string&gt; &lt;string&gt;String content&lt;/string&gt; &lt;/AnnotationsIVR&gt; &lt;/SchedTerminalCombo&gt; &lt;/TerminalCombos&gt; &lt;/SchedResponse&gt;</pre> </p> <p> <a name="response-json">The following is an example response Json body:</a> <pre class="response-json">{ "ScheduleID":2147483647, "ScheduleName":"String content", "ScheduleSeason":0, "SchedulePDFUrl":"String content", "ScheduleStart":"\/Date(928174800000-0700)\/", "ScheduleEnd":"\/Date(928174800000-0700)\/", "AllRoutes":[2147483647], "TerminalCombos":[{ "DepartingTerminalID":2147483647, "DepartingTerminalName":"String content", "ArrivingTerminalID":2147483647, "ArrivingTerminalName":"String content", "SailingNotes":"String content", "Annotations":["String content"], "Times":[{ "DepartingTime":"\/Date(928174800000-0700)\/", "ArrivingTime":"\/Date(928174800000-0700)\/", "LoadingRule":0, "VesselID":2147483647, "VesselName":"String content", "VesselHandicapAccessible":true, "VesselPositionNum":2147483647, "Routes":[2147483647], "AnnotationIndexes":[2147483647] }], "AnnotationsIVR":["String content"] }] }</pre> </p> <p> <a name="response-schema">The following is the response Xml Schema:</a> <pre class="response-schema">&lt;xs:schema xmlns:tns="http://www.wsdot.wa.gov/ferries/schedule/" elementFormDefault="qualified" targetNamespace="http://www.wsdot.wa.gov/ferries/schedule/" xmlns:xs="http://www.w3.org/2001/XMLSchema"&gt; &lt;xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /&gt; &lt;xs:complexType name="SchedResponse"&gt; &lt;xs:sequence&gt; &lt;name="ScheduleID" type="xs:int" /&gt; &lt;name="ScheduleName" nillable="true" type="xs:string" /&gt; &lt;name="ScheduleSeason" type="tns:Season" /&gt; &lt;name="SchedulePDFUrl" nillable="true" type="xs:string" /&gt; &lt;name="ScheduleStart" type="xs:dateTime" /&gt; &lt;name="ScheduleEnd" type="xs:dateTime" /&gt; &lt;name="AllRoutes" nillable="true" type="tns:ArrayOfInt" /&gt; &lt;name="TerminalCombos" nillable="true" type="tns:ArrayOfSchedTerminalCombo" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="SchedResponse" nillable="true" type="tns:SchedResponse" /&gt; &lt;xs:simpleType name="Season"&gt; &lt;xs:restriction base="xs:string"&gt; &lt;xs:enumeration value="Spring" /&gt; &lt;xs:enumeration value="Summer" /&gt; &lt;xs:enumeration value="Fall" /&gt; &lt;xs:enumeration value="Winter" /&gt; &lt;/xs:restriction&gt; &lt;/xs:simpleType&gt; &lt;xs:element name="Season" nillable="true" type="tns:Season" /&gt; &lt;xs:complexType name="ArrayOfInt"&gt; &lt;xs:sequence&gt; &lt;maxOccurs="unbounded" name="int" type="xs:int" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="ArrayOfInt" nillable="true" type="tns:ArrayOfInt" /&gt; &lt;xs:complexType name="ArrayOfSchedTerminalCombo"&gt; &lt;xs:sequence&gt; &lt;maxOccurs="unbounded" name="SchedTerminalCombo" nillable="true" type="tns:SchedTerminalCombo" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="ArrayOfSchedTerminalCombo" nillable="true" type="tns:ArrayOfSchedTerminalCombo" /&gt; &lt;xs:complexType name="SchedTerminalCombo"&gt; &lt;xs:sequence&gt; &lt;name="DepartingTerminalID" type="xs:int" /&gt; &lt;name="DepartingTerminalName" nillable="true" type="xs:string" /&gt; &lt;name="ArrivingTerminalID" type="xs:int" /&gt; &lt;name="ArrivingTerminalName" nillable="true" type="xs:string" /&gt; &lt;name="SailingNotes" nillable="true" type="xs:string" /&gt; &lt;name="Annotations" nillable="true" type="tns:ArrayOfString" /&gt; &lt;name="Times" nillable="true" type="tns:ArrayOfSchedTime" /&gt; &lt;name="AnnotationsIVR" nillable="true" type="tns:ArrayOfString" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="SchedTerminalCombo" nillable="true" type="tns:SchedTerminalCombo" /&gt; &lt;xs:complexType name="ArrayOfString"&gt; &lt;xs:sequence&gt; &lt;maxOccurs="unbounded" name="string" nillable="true" type="xs:string" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="ArrayOfString" nillable="true" type="tns:ArrayOfString" /&gt; &lt;xs:complexType name="ArrayOfSchedTime"&gt; &lt;xs:sequence&gt; &lt;maxOccurs="unbounded" name="SchedTime" nillable="true" type="tns:SchedTime" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="ArrayOfSchedTime" nillable="true" type="tns:ArrayOfSchedTime" /&gt; &lt;xs:complexType name="SchedTime"&gt; &lt;xs:sequence&gt; &lt;name="DepartingTime" type="xs:dateTime" /&gt; &lt;name="ArrivingTime" nillable="true" type="xs:dateTime" /&gt; &lt;name="LoadingRule" type="tns:LoadIndicator" /&gt; &lt;name="VesselID" type="xs:int" /&gt; &lt;name="VesselName" nillable="true" type="xs:string" /&gt; &lt;name="VesselHandicapAccessible" type="xs:boolean" /&gt; &lt;name="VesselPositionNum" type="xs:int" /&gt; &lt;name="Routes" nillable="true" type="tns:ArrayOfInt" /&gt; &lt;name="AnnotationIndexes" nillable="true" type="tns:ArrayOfInt" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="SchedTime" nillable="true" type="tns:SchedTime" /&gt; &lt;xs:simpleType name="LoadIndicator"&gt; &lt;xs:restriction base="xs:string"&gt; &lt;xs:enumeration value="Passenger"&gt; &lt;xs:annotation&gt; &lt;xs:appinfo&gt; &lt;EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/"&gt;1&lt;/EnumerationValue&gt; &lt;/xs:appinfo&gt; &lt;/xs:annotation&gt; &lt;/xs:enumeration&gt; &lt;xs:enumeration value="Vehicle"&gt; &lt;xs:annotation&gt; &lt;xs:appinfo&gt; &lt;EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/"&gt;2&lt;/EnumerationValue&gt; &lt;/xs:appinfo&gt; &lt;/xs:annotation&gt; &lt;/xs:enumeration&gt; &lt;xs:enumeration value="Both"&gt; &lt;xs:annotation&gt; &lt;xs:appinfo&gt; &lt;EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/"&gt;3&lt;/EnumerationValue&gt; &lt;/xs:appinfo&gt; &lt;/xs:annotation&gt; &lt;/xs:enumeration&gt; &lt;/xs:restriction&gt; &lt;/xs:simpleType&gt; &lt;xs:element name="LoadIndicator" nillable="true" type="tns:LoadIndicator" /&gt; &lt;/xs:schema&gt;</pre> </p> <p> <a name="response-schema">Additional response Xml Schemas:</a> <pre class="response-schema">&lt;xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"&gt; &lt;xs:element name="anyType" nillable="true" type="xs:anyType" /&gt; &lt;xs:element name="anyURI" nillable="true" type="xs:anyURI" /&gt; &lt;xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /&gt; &lt;xs:element name="boolean" nillable="true" type="xs:boolean" /&gt; &lt;xs:element name="byte" nillable="true" type="xs:byte" /&gt; &lt;xs:element name="dateTime" nillable="true" type="xs:dateTime" /&gt; &lt;xs:element name="decimal" nillable="true" type="xs:decimal" /&gt; &lt;xs:element name="double" nillable="true" type="xs:double" /&gt; &lt;xs:element name="float" nillable="true" type="xs:float" /&gt; &lt;xs:element name="int" nillable="true" type="xs:int" /&gt; &lt;xs:element name="long" nillable="true" type="xs:long" /&gt; &lt;xs:element name="QName" nillable="true" type="xs:QName" /&gt; &lt;xs:element name="short" nillable="true" type="xs:short" /&gt; &lt;xs:element name="string" nillable="true" type="xs:string" /&gt; &lt;xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /&gt; &lt;xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /&gt; &lt;xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /&gt; &lt;xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /&gt; &lt;xs:element name="char" nillable="true" type="tns:char" /&gt; &lt;xs:simpleType name="char"&gt; &lt;xs:restriction base="xs:int" /&gt; &lt;/xs:simpleType&gt; &lt;xs:element name="duration" nillable="true" type="tns:duration" /&gt; &lt;xs:simpleType name="duration"&gt; &lt;xs:restriction base="xs:duration"&gt; &lt;xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /&gt; &lt;xs:minInclusive value="-P10675199DT2H48M5.4775808S" /&gt; &lt;xs:maxInclusive value="P10675199DT2H48M5.4775807S" /&gt; &lt;/xs:restriction&gt; &lt;/xs:simpleType&gt; &lt;xs:element name="guid" nillable="true" type="tns:guid" /&gt; &lt;xs:simpleType name="guid"&gt; &lt;xs:restriction base="xs:string"&gt; &lt;xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /&gt; &lt;/xs:restriction&gt; &lt;/xs:simpleType&gt; &lt;xs:attribute name="FactoryType" type="xs:QName" /&gt; &lt;xs:attribute name="Id" type="xs:ID" /&gt; &lt;xs:attribute name="Ref" type="xs:IDREF" /&gt; &lt;/xs:schema&gt;</pre> </p> <p> <pre class="response-schema">&lt;tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"&gt; &lt;tns:element name="schema"&gt; &lt;tns:complexType /&gt; &lt;/tns:element&gt; &lt;/tns:schema&gt;</pre> </p> </div> </body> </html>