Required Field List

/api/v1/sightseeing/required-fields

This API retrieves a list of mandatory fields required for processing sightseeing results. Each sightseeing product comes with specific fields that must be selected and handled in a defined sequence.
The lifecycle of each field includes two main phases:
Retrieval Phase: Fetching the details of the required fields.
Patching Phase: Updating or modifying the values of these fields as needed.

By following this sequential flow, the service ensures that all necessary data is properly managed for each sightseeing product.

Steps in the Required Field Process

Step Type	Description
Dynamic	Only the first required field step is returned initially. The next required field step is included in the response after the current step is patched.
Fixed	All required field steps are returned sequentially in the initial response. The next step is also included in the response after the current step is patched.

Key Points to Understand:

Dynamic Steps
- Purpose: Suitable for workflows where the required fields are not predefined and evolve as the process progresses.
- How It Works:
Each step dynamically determines the fields for the next step. To move forward, you must update (patch) the current step to retrieve details for the subsequent step.

Fixed Steps
- Purpose: Ideal for workflows requiring all necessary steps and fields to be known upfront.
- How It Works:
The complete sequence of required fields is provided in the initial response. This ensures a predictable and straightforward process.

Why This Approach?
The service is designed to ensure that workflows are structured, reliable, and efficient. By adapting to both dynamic and fixed scenarios, it offers flexibility while maintaining order and consistency.

List Of Required Field

S.no	Required Field	Description
1	Options	This step provide the available options for the sightseeing
2	Dates	This Step provide the available dates for the sightseeing
3	Timeslots	This Step provide the available timeslots for the sightseeing
4	Language	This Step provide the available languages for the sightseeing
5	Pickup	This Step provide the pickup options for the sightseeing
6	Extras	This Step provide the extra addons for the sightseeing
7	Seat Map	This Step provide the Seat map for the sightseeing
8	Shipment Method	This Step provide the available shipment method for the sightseeing
9	Tickets	This Step provide the available tickets/pax option for the sightseeing
10	Customer Info	This step provide the dynamic question as well as passenger info question

Required Field Request

Tags	Attribute	Description
searchKey	searchKey* (String)	This attribute serves as a unique search identifier that enables the identification of a specific user flow request.
offerId	offerId* (String)	A unique offer id used for all subsequent API calls to identify user selected result.

Required Field Request
{
    "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
    "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025"
}

Required Field Response

Tags	Attributes	Description
meta	meta (JsonObject)	Metadata about the API response.
	success (String)	Response status will be returned. Example: "true".
	statusCode (Boolean)	Response statusCode will be returned. Example: "1".
	statusMessage (String)	Response statusMessage will be returned. Example: "SUCCESS".
commonData	commonData (JsonObject)	This tag contains the common data in the response.
	searchKey (String)	A unique search ID will be returned in the search response.
data	data (JsonArray)	Contains detailed information about the products or offers.
	offerId (String)	Contains the unique id for the specific result
	workflowId (String)	Contains the Unique workflow Id for the flow (To be Sent in all upcoming requests)
	steps (String)	Can be DYNAMIC or FIXED
requiredBookingFields	requiredBookingFields (StringArray)	Contains all required field step in Sequential Order

Fixed steps Required Field Response
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "GET REQUIRED FIELD",
        "conversationId": "e380b354-0761-46d8-a802-98cc3fa5544e"
    },
    "commonData": {
        "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675"
    },
    "data": [
        {
            "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
            "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
            "steps": "FIXED",
            "requiredBookingFields": [
                "DATES",
                "TIMESLOTS",
                "TICKETS",
                "PICKUP",
                "CUSTOMER_INFO"
            ]
        }
    ],
    "version": "1.0.0"
}

Dynamic steps Required Field Response
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "GET REQUIRED FIELD",
        "conversationId": "e380b354-0761-46d8-a802-98cc3fa5544e"
    },
    "commonData": {
        "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675"
    },
    "data": [
        {
            "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
            "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
            "steps": "DYNAMIC",
            "requiredBookingFields": [
                "OPTIONS"
            ]
        }
    ],
    "version": "1.0.0"
}