Updated Documentation for OMNY Needs

This document describes the addition features required for the OMNY trip planning application. These features are currently available on the demo site. Once these features have been thoroughly tested, they will be released to production and this documentation will be moved into the full production documentation found here:

Updated Fares Data

Multiple Fare Types

The MTA can have multiple fares for different users, e.g., users eligible for reduced fare or users that have a monthly pass will not pay full fare for a trip. In order to show these different fares in the OMNY app, OTP needs to return multiple fares types for each trip.

The current demo server shows fares in the following format.

<fare>
    <fare>
        <***FARETYPE1***>
            <currency>
                <symbol>**CURRENCY SYMBOL (e.g., $)**</symbol>
                <currency>**STRING (e.g., USD)**</currency>
                <defaultFractionDigits>**Number of Decimals Points for Rounding**</defaultFractionDigits>
                <currencyCode>**CURRENCY CODE (e.g., USD)**</currencyCode>
            </currency>
            <cents>**COST IN CENTS**</cents>
        </**FARETYPE1**>
        <**FARETYPE2**> ETC.
        <**FARETYPE3**> ETC. 
    </fare>
</fare>

Example:

<fare>
    <fare>
        <special>
            <currency>
                <symbol>$</symbol>
                <currency>USD</currency>
                <defaultFractionDigits>2</defaultFractionDigits>
                <currencyCode>USD</currencyCode>
            </currency>
            <cents>135</cents>
        </special>
        <regular>
            <currency>
                <symbol>$</symbol>
                <currency>USD</currency>
                <defaultFractionDigits>2</defaultFractionDigits>
                <currencyCode>USD</currencyCode>
            </currency>
            <cents>275</cents>
        </regular>
    </fare>
</fare>

Fares within Legs

http://otp-mta-demo.camsys-apps.com/otp/routers/default/plan?fromPlace=40.80965166748853%2C-73.9541244506836&toPlace=40.71629785715124%2C-74.00768280029297&time=5%3A22pm&date=07-10-2019&mode=TRANSIT%2CWALK&maxWalkDistance=804.672&arriveBy=false&wheelchair=false&locale=en &apikey=z6odKJINMNQww8M1zWfFoTMCUPcfbKnt

http://localhost:8080/

OMNY-enabled Stops