search.md

Search By Keywords.

GET /search

Description

Search location of landscapes, buildings or faculties by keywords.

Request

Headers

Name	Required	Description
X-NCU-API-TOKEN	yes	your API token

## Query parameters

Name	Required	Description
q	yes	keywords
size	no	1 <= size <= 5, defaults to 3.

Example

GET /search?q=志希

Response

Formats

• json

Structure

Field Name	Type	Value Description
chineseName	String	place's Chinese name
englishName	String	place's English name
type	Enum	[Place Type]
location	LatLng	latlng object lat Latitude lng Longitude

Example

[
    {
        "chineseName" : "志希館",
        "englishName" : "Zhi-Xi Building",
        "type" : "ADMINISTRATION",
        "location" : {
            "lat" : 24.970126,
            "lng" : 121.193683
        }
    }
]

Notes

• Place Type