TIH API Updates - New Version v2

Applicable for all TIH APIs(except Visit Singapore Account APIs).

New domain name:  api.stb.gov.sg

Old domain name:  tih-api.stb.gov.sg

• Content User API
• Deals User API
• Media User API
• Enhanced Navigation Map API
• Itinerary Planner API

Enhancement Changes:

Changes to the pagination method in the TIH APIs with pagination.

• Added new request parameters "limit" and "offset".
  • "limit" parameter defines the maximum number of records that can be returned. When no limit is defined, the limit will be set to a default value 20. The maximum value is 50.
  • "offset" parameter defines the number of records that will be discarded before returning the response. The default value is 0.
• Removed request parameters "nextToken", "maxrecord", "page" and "pageSize".

https://api.stb.gov.sg/content/attractions/v2/search?limit=20&offset=0

• Added new fields "TotalRecords" and "RetrievedRecords" in API response.
  • “TotalRecords” field will be assigned the total record count value.
  • “RetrievedRecords” field will be assigned the count of records for that response.
• The API response of paginated records will also include links to "first", "next", "previous" and "last" pages, where applicable.
  • first attribute provides a link to the first page.
  • next attribute provides a link to the next page.
  • previous attribute provides a link to the previous page.
  • last attribute provides a link to the last page.

{
... ...
"paginationLinks": {
“self”: “https://api.stb.gov.sg/content/attractions/v2/search?limit=20&offset=60”,
“first”: https://api.stb.gov.sg/content/attractions/v2/search?limit=20&offset=0”,
“prev”: “https://api.stb.gov.sg/content/attractions/v2/search?limit=20&offset=40”,
“next”: “https://api.stb.gov.sg/content/attractions/v2/search?limit=20&offset=80”,
},
"totalRecords": 100,
"retrievedRecords": 20
}

APIs:

• Content User API
• Deals User API
• Media User API

Enhancement Changes:

Content User APIs & Deals User APIs

• For each content category, both search <Category>ByKeyword API and get<Category>ByUuids API are merged into a single API that supports both keyword and UUIDs search, as follows:
  • Search Accommodation By Keyword or UUIDs API
  • Search Attractions By Keyword or UUIDs API
  • Search Bars & Clubs By Keyword or UUIDs API
  • Search Cruises By Keyword or UUIDs API
  • Search Events By Keyword or UUIDs API
  • Search Food & Beverages By Keyword or UUIDs API
  • Search Malls & Shops By Keyword or UUIDs API
  • Search Precincts By Keyword or UUIDs API
  • Search Tours By Keyword or UUIDs API
  • Search Venues By Keyword or UUIDs API
  • Search Walking Trails By Keyword or UUIDs API
• For deals, both searchDealsByKeyword API and getDealsByUuids API are merged into a single Search Deals By Keyword or UUIDs API that supports both keyword and UUIDs search. 
• The merged API will have new request parameters "searchType" and "searchValue".
  • "searchType" parameter: can have values either "keyword" or "uuids".
  • "searchValues" parameter: [keywords] if "searchType=keyword" or [one or a list of uuids separated by comma] if "searchType=uuids".

https://api.stb.gov.sg/content/bars-clubs/v2/search?searchType=keyword&searchValues=Marina Bay

https://api.stb.gov.sg/content/bars-clubs/v2/search?searchType=uuids&searchValues={list of uuids}

Media User APIs

• For libraries, both librarySearchByKeyword API and libraryByUUID API are merged into a single Search Libraries By Keyword or UUIDs API that supports both keyword and UUIDs search.
• For media, both search by keyword APIs (searchMediaByKeyword, documentSearchByKeyword, imageSearchByKeyword, videoSearchByKeyword) and by UUID APIs (getMediaByUUID, documentByUUID, imageByUUID, videoByUUID) are also merged into a single Search Media By Keyword or UUIDs API that supports both keyword and UUIDs search.
• The merged API will have new request parameters "searchType" and "searchValue", similar to Content User APIs.

https://api.stb.gov.sg/media/common/v2/search?searchType=keyword& searchValues=Marina Bay

https://api.stb.gov.sg/media/common/v2/search?searchType=uuids& searchValues={list of uuids}

APIs:

• List Content Types API
• List Media Content Types API
• Content & Media Autocomplete List API

Enhancement Changes:

List Content Types APIs

The following Content list<Category>Types APIs are merged into a single List Content Types API to retrieve the list of content types (or sub-categories) for each category. The merged API will have a new request parameter "category" which can have value [accommodation | attractions | bars_clubs | cruises | events | food_beverages | precincts | shops | tours | venues | walking_trails] to indicate the content category.

• listAccommodationTypes
• listAttractionsTypes
• listBarsClubsTypes
• listCruisesTypes
• listEventTypes
• listFoodBeveragesTypes
• listShopsTypes
• listTourTypes
• listVenueTypes
• listWalkingTrailTypes

List Media Content Types APIs

The following Media list<Category>Types APIs are merged into a single List Media Content Types API to retrieve the list of media content types (or sub-categories) for each category. The merged API will have a new request parameter "category" which can have value [accommodation | attractions | bars_clubs | cruises | events | food_beverages | precincts | shops | tours | venues | walking_trails] to indicate the media content category.

• listAccommodationTypes
• listAttractionTypes
• listBarsClubsTypes
• listCruisesTypes
• listEventFestivitiesTypes
• listFoodBeveragesTypes
• listShopsTypes
• listTourTypes
• listVenuesTypes

Content & Media - AutoComplete List By Type API

The following two APIs are merged into a single AutoComplete List By Type API for both content and media. The merged API will have a new request parameter "searchResourceType" which can have values "content" or "media" to indicate the resource type to search.

• autoCompleteByType (Content)
• autoCompleteByType (Media)

APIs:

• Content Provider API
• Content User API

Enhancement Changes:

All content categories:

• Aligned all 11 content categories (dataset) to plural form across all APIs.

Attractions, Shops, Bars & Clubs, Food & Beverages and Tours content category:

• Changed field name "notes" (for business hours) to "businessHourNotes.notes". Example:
  

  "businessHourNotes": {
     "notes": "Opens only on Mondays"
  }

Attractions content category:

• Changed data type of field "pricing" from string to the following object. Example:
  

  "pricing": {
     "others": "$100"
  }

Cruises content category:

• Changed maximum field length of field "organisationName' to 100 characters.

Events content category:

• Changed field name "price" to "pricing".
• Changed maximum field length of field "eventOrganizer' to 100 characters.

Precincts content category:

• Changed field name 'perimeter["lat"]' to 'perimeter["latitude"]'.
• Changed field name 'perimeter["lon"]' to 'perimeter["longitude"]'.
• Changed maximum field length of field "organisationName' to 100 characters.

Tours content category:

• Changed field name "price" to "pricing".
• Change field name "language" to "tourLanguage".
• Changed maximum field length of field "companyName' to 100 characters.

Venues content category:

• Changed field name "configurable" to "layoutConfigurable".

Search Company By Keyword API:

• Changed field name "status" to "companyStatus".