Enhanced Events Content Category & API Enhancements

1. Enhanced Events Content Category

The Events content category on TIH has been enhanced to support two types of events creation, namely Events - Leisure and Events - Business.

  • The Events - Business category is a new category with its new set of APIs.
  • The existing set of Events category APIs will be re-categorised as Events - Leisure category.
  • Changes includes:
    • "categoryDescription" field value:
      • The "categoryDescription" field value of the existing Events category returned in API response will be changed from "Events" to "Events - Leisure".
      • The "categoryDescription" field value of the Events - Business category will be "Events - Business"
    • "dataset" field value:
      • There will be no change to the "dataset" field value of existing Events category which remains as "events".
      • The "dataset" field value of the Events - Business category will be "mice_events".

Appended below is the list of new Events - Business category APIs that will be available:

  • Content User APIs for extracting content
    • Search Business/MICE Events By Keyword or UUIDs
    • Download Business/MICE Event Logo
    • List Business/MICE Event Modes
    • List Business/MICE Event Types
  • Content Provider APIs for contributing content
    • Create, Update, Delete Business/MICE Events
    • Upload Business/MICE Event Logo

More information on the Events - Leisure and Event - Business categories APIs is available in the API documentation pages and API User Guide - Content.

 

2. API Enhancements & Changes

2.1 New Filtering By Content Type (or Sub-category) for Content

Currently, each content category has a set of content type (also known as sub-categories). Existing APIs do not support filtering of the content by content type.

With the new enhancement, the following APIs can now support filtering by content type of a particular category/dataset:

This can be done by using the new request parameter "typeId":

  • "typeId" parameter defines the content types associated to a selected category/dataset to be filtered by.
  • The "typeId" parameter accepts the "id" values of content types which can be obtained from the enhanced version 3 of List Content Types API. Related information below^.
  • In order to use this filtering feature, only 1 dataset value is allowed in the "dataset" parameter and the content types has to be associated to the selected dataset.

 

^Related changes to the List Content Types API and List Media Content Types API:

  • The current version 2 of List Content Types API and List Media Content Types API retrieve the list of content types for each category.
  • The new version 3 of List Content Types API and List Media Content Types API have been enhanced to retrieve both the list of "typeId" and "name" values of content types for each category.
  • For List Content Type API version 3,
    • The "typeId" values can be used for filtering by content types (or sub-categories) in the APIs listed in section 2.1 above.
    • The "name" values can be used for specifying the "type" field value when creating a POI listing on TIH using Content Provider API. You can obtain the "name" values in the various languages (English (default), Simplified Chinese, Traditional Chinese, Japanese and Korean) by providing the language value in the request header under “X-Content-Language”.
  • For List Media Content Types API version 3,
    • The "name" values can be used for specifying the "subCategory" field value when creating a library/media listing on TIH using Media Provider API. The "name" values for library/media are only in English language.

 

2.2 New Search Multiple Datasets By UUIDs API

This new Search Multiple Datasets By UUIDs API support content search by UUIDs across categories/dataset. This helps to reduce the need to integrate with a different API endpoint for each content category in some instances.

Supported request parameters for this API:

  • "searchValues" parameter: [one or a list of uuids separated by comma and up to a maximum of 50 uuids]
  • "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. To obtain the information of all uuids provided in the "searchValues" parameter in a single API call, set the "limit" parameter as 50.
  • "offset" parameter defines the number of records that will be discarded before returning the response. The default value is 0.

 

3. Discontinuation of Media Type Document

Please be informed that the media type document will be discontinued on 30 June 2024. Appended below is the list of APIs that will be discontinued:

a) Media Provider APIs

  • Create, Update, Delete Documents

b) Media User APIs

  • The "mediaType" query parameter will no longer support the "document" media type.