Ero sivun ”Journeys API” versioiden välillä

1 887 merkkiä poistettu ,  5. heinäkuuta 2014 kello 02.57
ei muokkausyhteenvetoa
Ei muokkausyhteenvetoa
Rivi 256: Rivi 256:


These queries return response like above, with entities matching the criteria. All query parameters are exclusive (if you specify multiple conditions, the conditions are ANDed together).
These queries return response like above, with entities matching the criteria. All query parameters are exclusive (if you specify multiple conditions, the conditions are ANDed together).
==== DayTypes ====
A client can access paged list of DAY TYPES by making HTTP GET request to url http://example.com/journeys/api/day-types
This request would produce following response:
<pre>
{
    "headers" : {
        "dataValidityPeriod" : {
            "validFrom" : "2013-01-01",
            "validTo" : "2013-05-31"
        },
        "startIndex" : 0,
        "pageSize" : 10,
        "moreData" : false
    },
    "data" : {
        "dayTypes" : [
            {
                "href" : "http://example.com/journeys/api/day-types/weekdays",
                "properties" : [
                    {
                        "daysOfWeek" : "Monday,Tuesday,Wednesday,Thursday,Friday"
                    }
                ]
            }
            ...
        ]
    }
}
</pre>
A client can access specific DAY TYPE'S details by for example issuing request at http://example.com/journeys/api/day-types/weekdays
This request would produce following response:
<pre>
{
    "headers" : {
        "dataValidityPeriod" : {
            "validFrom" : "2013-01-01",
            "validTo" : "2013-05-31"
        },
        "startIndex" : 0,
        "pageSize" : 1,
        "moreData" : false
    },
    "data" : {
        "dayTypes" : [
            {
                "href" : "http://example.com/journeys/api/day-types/weekdays",
                "properties" : [
                    {
                        "daysOfWeek" : "Monday,Tuesday,Wednesday,Thursday,Friday"
                    }
                ]
            }
        ]
    }
}
</pre>
=== Search Queries ===
TBW
A client can search LINES by issuing following requests:<br>
* http://example.com/journeys/api/lines?name=13 will return LINES which name contains text "13" (case-insensitive)
* http://example.com/journeys/api/lines?description=Hermia will return LINES which description contains text "Hermia" (case-insensitive)
0

muokkausta