Get Cruises By Resource Id

get

Get Cruises By Resource Id

Retrieve data for a single resource under Cruises by providing the resource identifier (resourceId). You may use the datasetId to query for the resourceId from List Resources By Dataset API. The datasetId may be obtained from List Datasets By Topic API.

Resource URL

https://tih-api.stb.gov.sg /analytics/cruises/open/v1/data

Header Parameters

Name Values Description
Content-Type

Format of the request body sent. Accepts only application/json.

Accept

Format of the response body returned. Returns only application/json.

Query Parameters

Name Values Description
resourceId
(required)

Attribute used to identify each unique resource under Cruises topic in Data Marketplace. Accepts one resourceId. If no matching resourceId is found, response will return empty result.

Validation: valid resourceId

limit

Maximum number of data records to return in a response.

Default set to 20, with maximum of 50. Response will return 50 data records if value entered exceeds the maximum.

Validation: integer

offset

The first position to return from the results, by offsetting the starting point.

Default set to 0, which starts the page at the first record. Response will be empty if value for offset exceeds the total number of records.

Validation: integer

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 Description
400 Bad Request — Request was not accepted and could be due to malformed parameter (e.g. spelling error) or missing a required parameter.
401 Unauthorised — API key is invalid or was not provided.
403 Forbidden — API key does not have the permission to perform the request.
404 Resource Not Found — Requested resource (i.e. the resource URL) does not exist.
405 Method Not Allowed — The HTTP request method is not supported by the resource.
406 Not Acceptable — Requester's acceptable content type for the response does not match the content type returned by the resource.
414 Request URL Too Long — Request URL exceeded the maximum acceptable URL length.
415 Unsupported Media Type — Request's format is not supported by the resource.
422 Unprocessable Entity — Request was not accepted, often due to semantic errors, such as data format.
500 Server Errors — Something is not working on TIH's end, happened very rarely.

Resource Summary

Security Category

Cruises

Working...