Overview
The Sightseeing Service is a comprehensive platform for exploring tourist destinations, safaris, and hotel stays. This service offers various endpoints to search, select options, retrieve details, book, and manage cancellations and cancellation policies for these experiences.
API service to be exposed
| API Call | API end point(POST) | Request message | Response message |
|---|---|---|---|
| Log-In | /api/v1/auth/login | loginRequest | loginResponse |
| Sightseeing Search | /api/v1/sightseeing/search | sightseeingSearchRequest | sightseeingSearchResponse |
| Sightseeing options | /api/v1/sightseeing/options | sightseeingOptionsRequest | sightseeingOptionsResposne |
| Sightseeing Details | /api/v1/sightseeing/details | sightseeingDetailRequest | sightseeingDetailResposne |
| Get Sightseeing Cancellation policies | /api/v1/sightseeing/cancellation-policy | sightseeingCancellationPolicyRequest | sightseeingCancellationPolicyResponse |
| Sightseeing Book | /api/v1/reservation/sightseeing-book | sightseeingBookRequest | sightseeingBookResponse |
| Cancellation | api/v1/reservation/sightseeing-cancel | sightseeingCancellationRequest | sightseeingCancellationResponse |
| Log-Out | /api/v1/auth/logout | logoutRequest | logoutResponse |
Sightseeing Work Flow
graph TD
Start((Start)) --> Login[Login
api/v1/auth/login] Login --> SightseeingSearch[Sightseeing Search
/api/v1/sightseeing/search] SightseeingSearch --> SightseeingOptions[Sightseeing Options
/api/v1/sightseeing/options] SightseeingOptions --> SightseeingDetails[Sightseeing Details
/api/v1/sightseeing/details] SightseeingSearch --> SightseeingDetails SightseeingDetails --> SightseeingBook[Sightseeing Book
/api/v1/reservation/sightseeing-book] SightseeingBook -->Logout[Logout
api/v1/auth/logout] SightseeingBook --> Cancel[Sightseeing Cancel
/api/v1/reservation/sightseeing-cancel] Cancel --> Logout Logout --> Stop((Stop))
api/v1/auth/login] Login --> SightseeingSearch[Sightseeing Search
/api/v1/sightseeing/search] SightseeingSearch --> SightseeingOptions[Sightseeing Options
/api/v1/sightseeing/options] SightseeingOptions --> SightseeingDetails[Sightseeing Details
/api/v1/sightseeing/details] SightseeingSearch --> SightseeingDetails SightseeingDetails --> SightseeingBook[Sightseeing Book
/api/v1/reservation/sightseeing-book] SightseeingBook -->Logout[Logout
api/v1/auth/logout] SightseeingBook --> Cancel[Sightseeing Cancel
/api/v1/reservation/sightseeing-cancel] Cancel --> Logout Logout --> Stop((Stop))
Response Meta Data
Each response has metadata section, and it will describe overall status of each response. The Metadata parameters are given below.
| Tags | Attribute | Description |
|---|---|---|
| meta | meta (Object) |
Meta data Tag |
| success (String) |
Response status will be return. Ex: "true" OR "false" |
|
| statusCode (String) |
Response statusCode will be return. Ex: -3, -2, -1, 0, 1, 2, 3 |
|
| statusMessage (String) |
Response statusMessage will be return. Ex: NOT FOUND UNAUTHORIZED ERROR WARNING SUCCESS FETCH LATER NOT YET AVAILABLE |