searchCruisesByKeyword

get

searchCruisesByKeyword

Perform a search on all Cruises based on keyword as the search parameter. The keyword will match with names, description and tags, returning you the most relevant Cruises.

Resource URL

https://tih-api.stb.gov.sg/content /v1/cruises/search

Query Parameters

Name Values Description
keyword
(required)

Keyword to look for within name, description, body and tags when performing the search function.
Max: 255 characters

startMonth

Sailing start month.
Validation: month & year format in mm/yyyy
E.g. 10/2020

endMonth

Sailing end month.
Validation: month & year format in mm/yyyy
E.g. 11/2020

filtersource

Filter the content based on specific source or multiple sources by using a comma-delimited string of values.
Max: 255 characters
Validation: valid content source & case sensitive
E.g. stb,other countent source(s)

nextToken

Parameter to obtain the subsequent set of 20 records. The parameter is pulled directly from the output response provided by the API and should not be modified.
Max: 255 characters

sortBy

Field name to sort (name , type , description , source ).
Validation: acceptable value

sortOrder

Sort order [asc | desc].
Validation: acceptable sort order value

language

Supported language [en | zh-cn | zh-tw | ja | ko].
Validation: acceptable language code

group

Retrieve Points of Interest related to wellness (Wellness), SG Clean certification (SGClean) or Singapore Tourism Awards (STA) by using the group value(s) (Wellness, SGClean, STA). Provide one value or a comma-delimited string of values.
Max: 255 characters
E.g. Wellness,SGClean,STA

Try it out

HTTP Basic

OAuth 2.0

API Key

RESET

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

HTTP Code Error Code Description
400 400 Bad request
401 401 Unauthorized
404 404 Not Found

Resource Summary

Security Category

Cruises

Working...