Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 477 Bytes

places.md

File metadata and controls

33 lines (27 loc) · 477 Bytes

GET /api/places[/:cityId]

Return places list

Params:

type Request = {
    /**
     * City.id (optional) restrict places list to given City
     */
    cityId?: number;
}

Response:

type Place = {
    id: number;
    cityId: number;
    name: string;
};

type Response = Array<Place>

const example: Response = [
    {
        "id": 1,
        "cityId": 1,
        "name": "Chinggis Khaan International Airport (IATA: UBN, ICAO: ZMCK)"
    }
]