Skip to content

Required Booking Fields
Run in Postman

Each Required Field Step has its own dedicated endpoint that can be used for both retrieving and patching data.

The sequence for making calls to a Required Field endpoint is provided in the response of the Required Field API or in the PATCH response of the current Required Field Step.

Workflow for Required Field Steps

The process of completing a Required Field Step consists of two key actions:

Retrieve Available Options (POST)

  • This step allows you to fetch the list of possible choices for the specific Required Field Step.
  • The retrieved options represent what can be selected at this stage.

Select an Option (PATCH)

  • After reviewing the available options, you can select one that fits the requirement for the step.
  • Once an option is selected, the process may provide details about the next step in the sequence, guiding you through the workflow.


Important Notes:

  • PATCH Requests: A PATCH request must always be preceded by a POST request for the corresponding "Required Field Step."
  • Required Field Sequence: Follow the exact sequence of "Required Field Steps" as specified in the API response. This ensures data consistency. Deviating from the sequence may result in validation errors.
  • Multiple Selections: The fields TICKETS and EXTRAS support multiple selections in a PATCH request. All other fields support only a single selection in a PATCH request.
  • Re-Patching of Fields: If a previously patched "Required Field" is updated or retrieved again, all subsequent required fields must also be re-patched.


By adhering to this two-step process and sequence validation, you can ensure a smooth and reliable integration with the Required Field API.

Options

/api/v1/sightseeing/required-fields/options

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
options options
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "Get Options Field",
    "conversationId": "09e6dd89-e290-4e21-956c-d8394faf78f2"
  },
  "commonData": {
    "searchKey": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0"
  },
  "data": [
    {
      "offerId": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0XXXXXXTR00000000",
      "workflowId": "28400dbe-a752-4394-8052-062cf68d3e81",
      "options": [
        {
          "key": 1,
          "value": "Private tour - Standard Camp",
          "description": "Desert Safari, Dune Bashing and BBQ Dinner",
          "startingPrice": 863.77,
          "currency": "AED"
        },
        {
          "key": 2,
          "value": "Shared Tour  - Budget Camp",
          "description": "Desert Safari, Dune Bashing and BBQ Dinner",
          "startingPrice": 135.7,
          "currency": "AED"
        },
        {
          "key": 3,
          "value": "Shared tour - Standard Camp",
          "description": "Desert Safari, Dune Bashing and BBQ Dinner",
          "startingPrice": 143.97,
          "currency": "AED"
        },
        {
          "key": 4,
          "value": "Shared tour - Premium Service",
          "description": "Desert Safari, Dune Bashing and BBQ Dinner",
          "startingPrice": 186.99,
          "currency": "AED"
        }
      ]
    }
  ],
  "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "Patch Options Fields",
    "conversationId": "09e6dd89-e290-4e21-956c-d8394faf78f2"
  },
  "commonData": {
    "searchKey": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0"
  },
  "data": [
    {
      "offerId": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0HOTELBEDSSTR00000000",
      "workflowId": "28400dbe-a752-4394-8052-062cf68d3e81",
      "step": "OPTIONS",
      "nextStep": "DATES",
      "isFinalStep": false,
      "selectedData": [
        {
          "key": 1,
          "value": "Private tour - Standard Camp"
        }
      ]
    }
  ],
  "version": "1.0.0"
}



Dates

 /api/v1/sightseeing/required-fields/dates

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
dates dates
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Available Dates",
        "conversationId": "09e6dd89-e290-4e21-956c-d8394faf78f2"
    },
    "commonData": {
        "searchKey": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0"
    },
    "data": [
        {
            "offerId": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0XXXXXX00000000",
            "workflowId": "28400dbe-a752-4394-8052-062cf68d3e81",
            "dates": [
                {
                    "key": 1,
                    "value": "2025-01-08",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 2,
                    "value": "2025-01-09",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 3,
                    "value": "2025-01-10",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 4,
                    "value": "2025-01-11",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 5,
                    "value": "2025-01-12",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 6,
                    "value": "2025-01-13",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 7,
                    "value": "2025-01-14",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 8,
                    "value": "2025-01-15",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 9,
                    "value": "2025-01-16",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 10,
                    "value": "2025-01-17",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 11,
                    "value": "2025-01-18",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 12,
                    "value": "2025-01-19",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 13,
                    "value": "2025-01-20",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 14,
                    "value": "2025-01-21",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 15,
                    "value": "2025-01-22",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 16,
                    "value": "2025-01-23",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 17,
                    "value": "2025-01-24",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 18,
                    "value": "2025-01-25",
                    "startingPrice": 863.77,
                    "currency": "AED"
                },
                {
                    "key": 19,
                    "value": "2025-01-26",
                    "startingPrice": 863.77,
                    "currency": "AED"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "PATCH Available Dates",
        "conversationId": "09e6dd89-e290-4e21-956c-d8394faf78f2"
    },
    "commonData": {
        "searchKey": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0"
    },
    "data": [
        {
            "offerId": "2e9e43d3-2b3b-416a-b1f7-2130a23447d0XXXXXXX00000000",
            "workflowId": "28400dbe-a752-4394-8052-062cf68d3e81",
            "step": "DATES",
            "nextStep": "TICKETS",
            "isFinalStep": false,
            "selectedData": [
                {
                    "key": 5,
                    "value": "2025-01-12"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



Tickets

 /api/v1/sightseeing/required-fields/tickets

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
restrictions restrictions
(JsonArray)		 List of restrictions on the ticket
key
(String)		 Restriction Type
value
(String)		 Restriction Value
tickets tickets
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
description
(String)		 Description of the item
type
(String)		 Type of the Ticket
availableQuantity
(IntegerArray)		 Provided Total Amount of Tickets available
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
{
   "meta": {
      "success": true,
      "statusCode": 1,
      "statusMessage": "SUCCESS",
      "actionType": "Get Tickets Field",
      "conversationId": "af59ab0f-3536-4342-95db-aa1b85938f39"
   },
   "commonData": {
      "searchKey": "21625c05-6700-47aa-a5e2-b7958351ba60"
   },
   "data": [
      {
         "offerId": "21625c05-6700-47aa-a5e2-b7958351ba60HOTELBEDSSTR00000000",
         "workflowId": "28a53ecb-267c-4d82-a71b-1bb64257e0c3",
         "restrictions": [
            {
               "key": "ADULT_REQUIRED",
               "value": "true"
            },
            {
               "key": "OVERALL_MAX_TICKETS",
               "value": "20"
            },
            {
               "key": "MINIMUM_ADULT_REQUIRED",
               "value": "1"
            }
         ],
         "tickets": [
            {
               "key": 1,
               "value": "ADULT(3-999)",
               "type": "ADULT",
               "description": "Age: 3+",
               "startingPrice": 863.77,
               "availableQuantity": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20
               ],
               "currency": "AED"
            },
            {
               "key": 2,
               "value": "CHILD(0-2)",
               "type": "CHILD",
               "description": "Age: 0+",
               "startingPrice": 0.0,
               "availableQuantity": [
                  1,
                  2,
                  3,
                  4,
                  5,
                  6,
                  7,
                  8,
                  9,
                  10,
                  11,
                  12,
                  13,
                  14,
                  15,
                  16,
                  17,
                  18,
                  19,
                  20
               ]
            }
         ]
      }
   ],
   "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
quantity*
(Integer)		 Quantity of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1,
      "quantity": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
description
(String)		 Description of the Selected Item
price
(Double)		 Price of the Selected Item as per quantity
currency
(String)		 Currency of the Selected Item's Price
quantity
(Integer)		 Quantity of the selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "Patch Tickets Fields",
    "conversationId": "d80dfeb9-b5eb-4526-a1d5-e5800c47c050"
  },
  "commonData": {
    "searchKey": "536d9384-d92b-4893-a662-718f37d2730d"
  },
  "data": [
    {
      "offerId": "536d9384-d92b-4893-a662-718f37d2730dHOTELBEDSSTR00000000",
      "workflowId": "9b32af7e-8cd6-4101-b2b3-df80db075fac",
      "step": "TICKETS",
      "nextStep": "CUSTOMER_INFO",
      "isFinalStep": false,
      "netAmount": 1727.53,
      "currency": "AED",
      "selectedData": [
        {
          "key": 1,
          "value": "ADULT(3-999)",
          "description": "Age: 3+",
          "price": 1727.53,
          "currency": "AED",
          "quantity": 2
        }
      ]
    }
  ],
  "version": "1.0.0"
}



Timeslots

 /api/v1/sightseeing/required-fields/time-slots

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
timeslots timeslots
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get TIMESLOTS FIELD",
        "conversationId": "b487c8d6-5b3e-4781-adac-25fa02e3730c"
    },
    "commonData": {
        "searchKey": "75b50e7b-2c2a-46de-bafe-34da45e2201e"
    },
    "data": [
        {
            "offerId": "75b50e7b-2c2a-46de-bafe-34da45e2201eXXXXX00000000",
            "workflowId": "6c92270c-b5ad-4f30-96e7-a9422ed665e3",
            "timeslots": [
                {
                    "key": 1,
                    "value": "08:00"
                },
                {
                    "key": 2,
                    "value": "09:00"
                },
                {
                    "key": 3,
                    "value": "10:00"
                },
                {
                    "key": 4,
                    "value": "15:15"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch TIMESLOTS FIELD",
        "conversationId": "b487c8d6-5b3e-4781-adac-25fa02e3730c"
    },
    "commonData": {
        "searchKey": "75b50e7b-2c2a-46de-bafe-34da45e2201e"
    },
    "data": [
        {
            "offerId": "75b50e7b-2c2a-46de-bafe-34da45e2201eXXXXXX00000000",
            "workflowId": "6c92270c-b5ad-4f30-96e7-a9422ed665e3",
            "step": "TIMESLOTS",
            "nextStep": "TICKETS",
            "isFinalStep": false,
            "selectedData": [
                {
                    "key": 1,
                    "value": "08:00"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



Pickup

 /api/v1/sightseeing/required-fields/pickup

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
pickup pickup
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Pickup Field",
        "conversationId": "b487c8d6-5b3e-4781-adac-25fa02e3730c"
    },
    "commonData": {
        "searchKey": "75b50e7b-2c2a-46de-bafe-34da45e2201e"
    },
    "data": [
        {
            "offerId": "75b50e7b-2c2a-46de-bafe-34da45e2201eXXXXXX00000000",
            "workflowId": "6c92270c-b5ad-4f30-96e7-a9422ed665e3",
            "pickup": [
                {
                    "key": 1,
                    "value": "Hotel",
                    "name": "Hotel"
                },
                {
                    "key": 2,
                    "value": "I will contact the supplier later",
                    "name": "I will contact the supplier later"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch Pickup Fields",
        "conversationId": "b487c8d6-5b3e-4781-adac-25fa02e3730c"
    },
    "commonData": {
        "searchKey": "75b50e7b-2c2a-46de-bafe-34da45e2201e"
    },
    "data": [
        {
            "offerId": "75b50e7b-2c2a-46de-bafe-34da45e2201eXXXXX00000000",
            "workflowId": "6c92270c-b5ad-4f30-96e7-a9422ed665e3",
            "step": "PICKUP",
            "nextStep": "CUSTOMER_INFO",
            "isFinalStep": false,
            "totalPrice": 2353.76,
            "currency": "AED",
            "selectedData": [
                {
                    "key": 1,
                    "value": "Hotel"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



Language

 /api/v1/sightseeing/required-fields/language

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
language language
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Language Field",
        "conversationId": "3909f470-74d5-4ec5-ae29-46a28a8b8350"
    },
    "commonData": {
        "searchKey": "3cc34027-45e0-4752-8426-b484c01e7d93"
    },
    "data": [
        {
            "offerId": "3cc34027-45e0-4752-8426-b484c01e7d93BRIDGIFYSTR00000222",
            "workflowId": "e96d90f1-4ea8-4f62-a475-49cf98ce29f0",
            "language": [
                {
                    "key": 1,
                    "value": "English - Guide"
                },
                {
                    "key": 2,
                    "value": "Arabic - Guide"
                },
                {
                    "key": 3,
                    "value": "Urdu - Guide"
                },
                {
                    "key": 4,
                    "value": "Hindi - Guide"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch Language Fields",
        "conversationId": "3909f470-74d5-4ec5-ae29-46a28a8b8350"
    },
    "commonData": {
        "searchKey": "3cc34027-45e0-4752-8426-b484c01e7d93"
    },
    "data": [
        {
            "offerId": "3cc34027-45e0-4752-8426-b484c01e7d93BRIDGIFYSTR00000222",
            "workflowId": "e96d90f1-4ea8-4f62-a475-49cf98ce29f0",
            "step": "LANGUAGE",
            "nextStep": "PICKUP",
            "isFinalStep": false,
            "netAmount": 246.43,
            "currency": "AED",
            "selectedData": [
                {
                    "key": 2,
                    "value": "Arabic - Guide"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



Extras

 /api/v1/sightseeing/required-fields/extras

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
restrictions restrictions
(JsonArray)		 List of restrictions on the ticket
key
(String)		 Restriction Type
value
(String)		 Restriction Value
extras extras
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
  "searchKey": "8c85b663-4008-40d4-93c0-b4XXXXX1308",
  "offerId": "8c85b663-4008-40d4-93c0-b42226691308XXXXXXXXXXXR00000000",
  "workflowId": "53b0c45b-0b37-4f9a-a8a9-bdee5af6bd59",
  "restriction": [
    {
      "key": "OVERALL_MAX_TICKETS",
      "value": "5"
    }
  ],
  "extras": [
    {
      "key": 1,
      "value": "food : meat",
      "description": "meat",
      "startingPrice": 2,
      "currency": "USD"
    },
    {
      "key": 2,
      "value": "Drink : PEPSI",
      "description": "Soft Drinks",
      "startingPrice": 3,
      "currency": "USD"
    }
  ]
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "meta": {
    "success": true,
    "statusCode": 1,
    "statusMessage": "SUCCESS",
    "actionType": "Patch Tickets Fields",
    "conversationId": "d80dfeb9-b5eb-4526-a1d5-e5800c47c050"
  },
  "commonData": {
    "searchKey": "536d9384-d92b-4893-a662-718f37d2730d"
  },
  "data": [
    {
      "offerId": "536d9384-d92b-4893-a662-718f37d2730dHOTELBEDSSTR00000000",
      "workflowId": "9b32af7e-8cd6-4101-b2b3-df80db075fac",
      "step": "EXTRAS",
      "nextStep": "CUSTOMER_INFO",
      "isFinalStep": false,
      "netAmount": 1727.53,
      "currency": "AED",
      "selectedData": [
        {
          "key": 1,
          "value": "food : meat"
        }
      ]
    }
  ],
  "version": "1.0.0"
}



Seat Map

 /api/v1/sightseeing/required-fields/seat-map

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
seatMap seatMap
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Seat Map Field",
        "conversationId": "b3a6748f-bb47-4394-83f5-7ae72c84290e"
    },
    "commonData": {
        "searchKey": "446d8ff5-1bae-4c22-a155-2ac8c3902293"
    },
    "data": [
        {
            "offerId": "446d8ff5-1bae-4c22-a155-2ac8c3902293BRIDGIFYSTR00005596",
            "workflowId": "c23d38cb-bccf-491e-a1e0-81f7d521a807",
            "seatMap": [
                {
                    "key": 1,
                    "value": "https://images-cdn.sportsevents365.com/venues/thumbs/9897969543.png"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch Seat Map Fields",
        "conversationId": "b3a6748f-bb47-4394-83f5-7ae72c84290e"
    },
    "commonData": {
        "searchKey": "446d8ff5-1bae-4c22-a155-2ac8c3902293"
    },
    "data": [
        {
            "offerId": "446d8ff5-1bae-4c22-a155-2ac8c3902293BRIDGIFYSTR00005596",
            "workflowId": "c23d38cb-bccf-491e-a1e0-81f7d521a807",
            "step": "SEAT_MAP",
            "nextStep": "TICKETS",
            "isFinalStep": false,
            "selectedData": [
                {
                    "key": 1,
                    "value": "https://images-cdn.sportsevents365.com/venues/thumbs/9897969543.png"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



Shipment Method

 /api/v1/sightseeing/required-fields/shipment-method

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
shipmentMethod shipmentMethod
(JsonArray)		 List of Required Field Options
key
(Integer)		 Key for item, to be used for selection
value
(String)		 Value of the item
name
(String)		 Name for the item (Will be returned if Available)
description
(String)		 Description about the item (Will be returned if Available)
startingPrice
(Double)		 Initial Price for the item ( Will be returned if Available)
currency
(String)		 Currency for Returned Price ( Will be returned if Available)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Shipment Method Field",
        "conversationId": "b3a6748f-bb47-4394-83f5-7ae72c84290e"
    },
    "commonData": {
        "searchKey": "446d8ff5-1bae-4c22-a155-2ac8c3902293"
    },
    "data": [
        {
            "offerId": "446d8ff5-1bae-4c22-a155-2ac8c3902293BRIDGIFYSTR00005596",
            "workflowId": "c23d38cb-bccf-491e-a1e0-81f7d521a807",
            "shipmentMethod": [
                {
                    "key": 1,
                    "value": "Mobile tickets sent to email",
                    "currency": "AED"
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
selectedData selectedData*
(JsonArray)		 List of selected item
key*
(Integer)		 Key of the Selected Item
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75",
  "selectedData": [
    {
      "key": 1
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedData selectedData
(JsonArray)		 List of selected item
key
(Integer)		 Key of the Selected Item
value
(String)		 Value of the Selected Item
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch Shipment Method Fields",
        "conversationId": "b3a6748f-bb47-4394-83f5-7ae72c84290e"
    },
    "commonData": {
        "searchKey": "446d8ff5-1bae-4c22-a155-2ac8c3902293"
    },
    "data": [
        {
            "offerId": "446d8ff5-1bae-4c22-a155-2ac8c3902293BRIDGIFYSTR00005596",
            "workflowId": "c23d38cb-bccf-491e-a1e0-81f7d521a807",
            "step": "SHIPMENT_METHOD",
            "nextStep": "CUSTOMER_INFO",
            "isFinalStep": false,
            "netAmount": 528.26,
            "currency": "AED",
            "selectedData": [
                {
                    "key": 1,
                    "value": "Mobile tickets sent to email"
                }
            ]
        }
    ],
    "version": "1.0.0"
}



CustomerInfo

 /api/v1/sightseeing/required-fields/customer-info

Retrieve Data

Request Method
POST
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
Sample Request
1
2
3
4
5
{
  "searchKey": "3138f805-a713-46cf-bb76-2390aadc2675",
  "offerId": "3138f805-a713-46cf-bb76-2390aadc2675XXXXXXTR00000025",
  "workflowId": "d56776de-fcc7-4a20-ae35-963af94b5d75"
}
Tags Attribute Description
meta meta (Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
customerInfo customerInfo
(JsonArray)		 List of Required Field Options
groupKey
(Integer)		 Key for the group, to be used for selection
groupName
(String)		 Name of the group
groupFields groupFields
(JsonArray)		 List of Field in the group
key
(Integer)		 Key of the Field Item, to be used in Patch Request
fieldName
(String)		 Name of the group field
type
(String)		 Input Type of the group filed
minimumLength
(Integer)		 Minimum Length for the Input
maximumLength
(Integer)		 Maximum Length for the Input
options options
(JsonArray)		 List of options for the field
optionKey
(String)		 Key for the Option, to be usec as value in Patch
optionName
(String)		 Display name for the option
Sample Response
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Get Customer Info Field",
        "conversationId": "d80dfeb9-b5eb-4526-a1d5-e5800c47c050"
    },
    "commonData": {
        "searchKey": "536d9384-d92b-4893-a662-718f37d2730d"
    },
    "data": [
        {
            "offerId": "536d9384-d92b-4893-a662-718f37d2730dHOTELBEDSSTR00000000",
            "workflowId": "9b32af7e-8cd6-4101-b2b3-df80db075fac",
            "customerInfo": [
                {
                    "groupKey": 1,
                    "groupName": "Supplier Question",
                    "groupFields": [
                        {
                            "key": 1,
                            "fieldName": "Please advise the name of your hotel",
                            "type": "string",
                            "minimumLength": 3,
                            "maximumLength": 255
                        }
                    ]
                },
                {
                    "groupKey": 2,
                    "groupName": "Required Customer Contact Info ADULT 1",
                    "groupFields": [
                        {
                            "key": 1,
                            "fieldName": "Title",
                            "type": "select",
                            "minimumLength": 2,
                            "maximumLength": 5,
                            "options": [
                                {
                                    "optionKey": "Mr",
                                    "optionName": "Mr"
                                },
                                {
                                    "optionKey": "Ms",
                                    "optionName": "Ms"
                                },
                                {
                                    "optionKey": "Mrs",
                                    "optionName": "Mrs"
                                },
                                {
                                    "optionKey": "Adt",
                                    "optionName": "Adt"
                                },
                                {
                                    "optionKey": "Dr",
                                    "optionName": "Dr"
                                },
                                {
                                    "optionKey": "Fr",
                                    "optionName": "Fr"
                                },
                                {
                                    "optionKey": "Capt",
                                    "optionName": "Capt"
                                },
                                {
                                    "optionKey": "Prof",
                                    "optionName": "Prof"
                                }
                            ]
                        },
                        {
                            "key": 2,
                            "fieldName": "First Name",
                            "type": "string",
                            "minimumLength": 3,
                            "maximumLength": 255
                        },
                        {
                            "key": 3,
                            "fieldName": "Last Name",
                            "type": "string",
                            "minimumLength": 3,
                            "maximumLength": 255
                        },
                        {
                            "key": 4,
                            "fieldName": "Email",
                            "type": "email",
                            "minimumLength": 3,
                            "maximumLength": 255
                        },
                        {
                            "key": 5,
                            "fieldName": "Phone",
                            "type": "phoneNumber",
                            "minimumLength": 8,
                            "maximumLength": 13
                        }
                    ]
                },
                {
                    "groupKey": 3,
                    "groupName": "Required Customer Contact Info ADULT 2",
                    "groupFields": [
                        {
                            "key": 1,
                            "fieldName": "Title",
                            "type": "select",
                            "minimumLength": 2,
                            "maximumLength": 5,
                            "options": [
                                {
                                    "optionKey": "Mr",
                                    "optionName": "Mr"
                                },
                                {
                                    "optionKey": "Ms",
                                    "optionName": "Ms"
                                },
                                {
                                    "optionKey": "Mrs",
                                    "optionName": "Mrs"
                                },
                                {
                                    "optionKey": "Adt",
                                    "optionName": "Adt"
                                },
                                {
                                    "optionKey": "Dr",
                                    "optionName": "Dr"
                                },
                                {
                                    "optionKey": "Fr",
                                    "optionName": "Fr"
                                },
                                {
                                    "optionKey": "Capt",
                                    "optionName": "Capt"
                                },
                                {
                                    "optionKey": "Prof",
                                    "optionName": "Prof"
                                }
                            ]
                        },
                        {
                            "key": 2,
                            "fieldName": "First Name",
                            "type": "string",
                            "minimumLength": 3,
                            "maximumLength": 255
                        },
                        {
                            "key": 3,
                            "fieldName": "Last Name",
                            "type": "string",
                            "minimumLength": 3,
                            "maximumLength": 255
                        }
                    ]
                }
            ]
        }
    ],
    "version": "1.0.0"
}


Patch Data

Request Method
PATCH
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.
workflowId workflowId*
(String)		 A Unique workflow id for Required field flow
customerInfo customerInfo*
(JsonArray)		 List of selected item
groupKey*
(Integer)		 Key of the Group
groupFields groupFields*
(JsonArray)		 Key of the Group
key*
(Integer)		 Key of the Field of that Group
value*
(String)		 Value for the Group Field
Sample Request
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
  "searchKey": "{{searchKey}}",
  "offerId": "{{offerId}}",
  "workflowId": "{{workflowId}}",
  "customerInfo": [
    {
      "groupKey": 1,
      "groupFields": [
        {
          "key": 1,
          "value": "Hotel"
        }
      ]
    },

    {
      "groupKey": 2,
      "groupFields": [
        {
          "key": 1,
          "value": "Mr"
        },
        {
          "key": 2,
          "value": "Prince"
        },
        {
          "key": 3,
          "value": "Kumar"
        },
        {
          "key": 5,
          "value": "+91737182121"
        },
        {
          "key": 4,
          "value": "Mrr@hk.com"
        },
        {
          "key": 6,
          "value": "Mrr"
        },
        {
          "key": 7,
          "value": "Mrr"
        },
        {
          "key": 8,
          "value": "2211446"
        }
      ]
    },
    {
      "groupKey":3,
      "groupFields":[
        {
          "key": 1,
          "value": "Mr"
        },
        {
          "key": 2,
          "value": "Neo"
        },
        {
          "key": 3,
          "value": "Kumar"
        }
      ]
    }
  ]
}
Tags Attribute Description
meta meta
(Object)
success
(String)		 Response status will be return Ex: "true"
statusCode
(Boolean)		 Response statusCode will be return Ex: "1"
statusMessage
(String)		 Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)		 This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)		 conversationId a unique identifier of current conversation .
commonData commonData
(JsonObject)
searchKey
(String)		 This attribute contains a unique search key.
data data
(JsonArray)		 This encloses Required Field information.
offerId
(String)		 A unique offer id used for all subsequent API calls to identify user selected result.
workflowId
(String)		 A Unique workflow id for Required field flow
step
(String)		 Name of Current Step
nextStep
(String)		 Name of Next Step ( Will be returned if isFinalStep is false )
isFinalStep
(Boolean)		 true if current step is last step else false
netAmount
(Double)		 Total Amount after Patching current required field
currency
(String)		 Currency of the returned netAmount
selectedCustomerInfo selectedCustomerInfo
(JsonArray)		 List of Selected Customer Info
groupName
(String)		 Name of the Group
groupFields groupFields
(JsonArray)		 List of Field item in the group
field
(String)		 Name of the field item
value
(String)		 Value of field item ( Same as provided in request)
Sample Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
    "meta": {
        "success": true,
        "statusCode": 1,
        "statusMessage": "SUCCESS",
        "actionType": "Patch Customer Info Fields",
        "conversationId": "d80dfeb9-b5eb-4526-a1d5-e5800c47c050"
    },
    "commonData": {
        "searchKey": "536d9384-d92b-4893-a662-718f37d2730d"
    },
    "data": [
        {
            "offerId": "536d9384-d92b-4893-a662-718f37d2730dXXXXXX00000000",
            "step": "CUSTOMER_INFO",
            "isFinalStep": true,
            "totalPrice": 1727.53,
            "currency": "AED",
            "selectedCustomerInfo": [
                {
                    "groupName": "Supplier Question",
                    "groupFields": [
                        {
                            "field": "Please advise the name of your hotel",
                            "value": "Hotel"
                        }
                    ]
                },
                {
                    "groupName": "Required Customer Contact Info ADULT 1",
                    "groupFields": [
                        {
                            "field": "Title",
                            "value": "Mr"
                        },
                        {
                            "field": "First Name",
                            "value": "Prince"
                        },
                        {
                            "field": "Last Name",
                            "value": "Kumar"
                        },
                        {
                            "field": "Email",
                            "value": "XXXXX@XXXX.com"
                        },
                        {
                            "field": "Phone",
                            "value": "+91XXXXXXXX"
                        }
                    ]
                },
                {
                    "groupName": "Required Customer Contact Info ADULT 2",
                    "groupFields": [
                        {
                            "field": "Title",
                            "value": "Mr"
                        },
                        {
                            "field": "First Name",
                            "value": "Neo"
                        },
                        {
                            "field": "Last Name",
                            "value": "Kumar"
                        }
                    ]
                }
            ]
        }
    ],
    "version": "1.0.0"
}