UNPKG

ws-dottie

Version:

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

208 lines 11.6 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/alerts?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/alerts?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/alerts?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;ArrayOfAlertResponse xmlns="http://www.wsdot.wa.gov/ferries/schedule/"&gt; &lt;AlertResponse&gt; &lt;BulletinID&gt;2147483647&lt;/BulletinID&gt; &lt;BulletinFlag&gt;true&lt;/BulletinFlag&gt; &lt;BulletinText&gt;String content&lt;/BulletinText&gt; &lt;CommunicationFlag&gt;true&lt;/CommunicationFlag&gt; &lt;CommunicationText&gt;String content&lt;/CommunicationText&gt; &lt;RouteAlertFlag&gt;true&lt;/RouteAlertFlag&gt; &lt;RouteAlertText&gt;String content&lt;/RouteAlertText&gt; &lt;HomepageAlertText&gt;String content&lt;/HomepageAlertText&gt; &lt;PublishDate&gt;1999-05-31T11:20:00&lt;/PublishDate&gt; &lt;DisruptionDescription&gt;String content&lt;/DisruptionDescription&gt; &lt;AllRoutesFlag&gt;true&lt;/AllRoutesFlag&gt; &lt;SortSeq&gt;2147483647&lt;/SortSeq&gt; &lt;AlertTypeID&gt;2147483647&lt;/AlertTypeID&gt; &lt;AlertType&gt;String content&lt;/AlertType&gt; &lt;AlertFullTitle&gt;String content&lt;/AlertFullTitle&gt; &lt;AffectedRouteIDs&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AffectedRouteIDs&gt; &lt;IVRText&gt;String content&lt;/IVRText&gt; &lt;/AlertResponse&gt; &lt;AlertResponse&gt; &lt;BulletinID&gt;2147483647&lt;/BulletinID&gt; &lt;BulletinFlag&gt;true&lt;/BulletinFlag&gt; &lt;BulletinText&gt;String content&lt;/BulletinText&gt; &lt;CommunicationFlag&gt;true&lt;/CommunicationFlag&gt; &lt;CommunicationText&gt;String content&lt;/CommunicationText&gt; &lt;RouteAlertFlag&gt;true&lt;/RouteAlertFlag&gt; &lt;RouteAlertText&gt;String content&lt;/RouteAlertText&gt; &lt;HomepageAlertText&gt;String content&lt;/HomepageAlertText&gt; &lt;PublishDate&gt;1999-05-31T11:20:00&lt;/PublishDate&gt; &lt;DisruptionDescription&gt;String content&lt;/DisruptionDescription&gt; &lt;AllRoutesFlag&gt;true&lt;/AllRoutesFlag&gt; &lt;SortSeq&gt;2147483647&lt;/SortSeq&gt; &lt;AlertTypeID&gt;2147483647&lt;/AlertTypeID&gt; &lt;AlertType&gt;String content&lt;/AlertType&gt; &lt;AlertFullTitle&gt;String content&lt;/AlertFullTitle&gt; &lt;AffectedRouteIDs&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;int&gt;2147483647&lt;/int&gt; &lt;/AffectedRouteIDs&gt; &lt;IVRText&gt;String content&lt;/IVRText&gt; &lt;/AlertResponse&gt; &lt;/ArrayOfAlertResponse&gt;</pre> </p> <p> <a name="response-json">The following is an example response Json body:</a> <pre class="response-json">[{ "BulletinID":2147483647, "BulletinFlag":true, "BulletinText":"String content", "CommunicationFlag":true, "CommunicationText":"String content", "RouteAlertFlag":true, "RouteAlertText":"String content", "HomepageAlertText":"String content", "PublishDate":"\/Date(928174800000-0700)\/", "DisruptionDescription":"String content", "AllRoutesFlag":true, "SortSeq":2147483647, "AlertTypeID":2147483647, "AlertType":"String content", "AlertFullTitle":"String content", "AffectedRouteIDs":[2147483647], "IVRText":"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:complexType name="ArrayOfAlertResponse"&gt; &lt;xs:sequence&gt; &lt;maxOccurs="unbounded" name="AlertResponse" nillable="true" type="tns:AlertResponse" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="ArrayOfAlertResponse" nillable="true" type="tns:ArrayOfAlertResponse" /&gt; &lt;xs:complexType name="AlertResponse"&gt; &lt;xs:sequence&gt; &lt;name="BulletinID" type="xs:int" /&gt; &lt;name="BulletinFlag" type="xs:boolean" /&gt; &lt;name="BulletinText" nillable="true" type="xs:string" /&gt; &lt;name="CommunicationFlag" type="xs:boolean" /&gt; &lt;name="CommunicationText" nillable="true" type="xs:string" /&gt; &lt;name="RouteAlertFlag" type="xs:boolean" /&gt; &lt;name="RouteAlertText" nillable="true" type="xs:string" /&gt; &lt;name="HomepageAlertText" nillable="true" type="xs:string" /&gt; &lt;name="PublishDate" nillable="true" type="xs:dateTime" /&gt; &lt;name="DisruptionDescription" nillable="true" type="xs:string" /&gt; &lt;name="AllRoutesFlag" type="xs:boolean" /&gt; &lt;name="SortSeq" type="xs:int" /&gt; &lt;name="AlertTypeID" type="xs:int" /&gt; &lt;name="AlertType" nillable="true" type="xs:string" /&gt; &lt;name="AlertFullTitle" nillable="true" type="xs:string" /&gt; &lt;name="AffectedRouteIDs" nillable="true" type="tns:ArrayOfInt" /&gt; &lt;name="IVRText" nillable="true" type="xs:string" /&gt; &lt;/xs:sequence&gt; &lt;/xs:complexType&gt; &lt;xs:element name="AlertResponse" nillable="true" type="tns:AlertResponse" /&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: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>