Skip to content

Commit ea99a74

Browse files
manas-tankmanas-tank
committed
seatmap booking api documentation
1 parent e815785 commit ea99a74

15 files changed

+365
-340
lines changed

‎apis/booking.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
## APIs
66

7-
METHOD | URL | AUTH | USAGE
8-
--- | --- | --- | ---
9-
GET | [`/booking`](#GET-/booking) | yes | Fetch all bookings.
10-
GET | [`/booking/{id}`](#GET-/booking/{id}) | yes | Fetch a booking by it's id.
11-
POST | [`/booking`](#POST-/booking) | yes | Create a booking in `UNCAPTURED` state.
12-
PUT | [`/booking/{id}`](#PUT-/booking) | yes | Modify the state of the booking given it's id.
13-
POST | *`DEPRECATED`* [~~`/booking/create`~~](#POST-/booking/create) | yes | Create a booking. Use: [`POST /booking`](#POST-/booking)
7+
| METHOD | URL | AUTH | USAGE |
8+
|--------|---------------------------------------------------------------|------|----------------------------------------------------------|
9+
| GET | [`/booking`](#get-booking) | yes | Fetch all bookings. |
10+
| GET | [`/booking/{id}`](#get-bookingid) | yes | Fetch a booking by it's id. |
11+
| POST | [`/booking`](#POST-/booking) | yes | Create a booking in `UNCAPTURED` state. |
12+
| PUT | [`/booking/{id}`](#PUT-/booking) | yes | Modify the state of the booking given it's id. |
13+
| POST | *`DEPRECATED`* [~~`/booking/create`~~](#POST-/booking/create) | yes | Create a booking. Use: [`POST /booking`](#POST-/booking) |
1414

15-
### <a name="GET-/booking"></a>GET `/booking`
15+
### <a name="GET-/booking"></a>GET `get-booking`
1616

1717
List all bookings.
1818

@@ -75,13 +75,13 @@ List all bookings.
7575

7676
### <a name="GET-/booking/{id}"></a>GET `/booking/{id}`
7777

78-
Get a booking by it's ID.
78+
Get a booking by its ID.
7979

8080
#### Request
8181

82-
MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
83-
--- | --- | --- | --- | ---
84-
PATH | id | string | no | The booking id.
82+
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
83+
|------|-----|--------|----------|-----------------|
84+
| PATH | id | string | no | The booking id. |
8585

8686
#### Response
8787

@@ -137,7 +137,7 @@ PATH | id | string | no | The booking id.
137137

138138
Create a new booking object in `UNCAPTURED` state.
139139

140-
The booking creation and acceptance flow is a 2 step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.
140+
The booking creation and acceptance flow is a 2-step flow. Calling this API creates the initial booking in `UNCAPTURED` state and returns back the same booking along with the new booking id. You should call this API before fulfilling the booking flow on your end. Once you get a response, you can then fulfill the booking flow on your end and then call [`PUT /booking`](#PUT-/booking) to capture the booking and start the fulfillment process of the booking on our end.
141141

142142
If the booking capturing doesn't happen within an hour then the booking status is automatically changed to `CAPTURE_TIMEOUT`.
143143

@@ -149,6 +149,7 @@ If the booking capturing doesn't happen within an hour then the booking status i
149149
{
150150
"variantId": "1234",
151151
"inventoryId": "1455",
152+
"inventorySeatIds": ["SE-GRANDCIRCLE-A-20","SE-GRANDCIRCLE-A-21"],
152153
"customersDetails": {
153154
"count": 3,
154155
"customers": [{
@@ -217,9 +218,11 @@ If the booking capturing doesn't happen within an hour then the booking status i
217218
}
218219
```
219220

221+
222+
220223
### <a name="PUT-/booking"></a>PUT `/booking/{id}`
221224

222-
Used to modify a booking. Currently this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.
225+
Used to modify a booking. Currently, this is only used for capturing the booking and assigning a `partnerReferenceId`. Use this method to capture the booking by specifying the status as `PENDING`. The booking will be fulfilled on our end only once you capture it.
223226

224227
#### Request
225228

‎apis/category.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44

55
## APIs
66

7-
METHOD | URL | AUTH | USAGE
8-
--- | --- | --- | ---
9-
GET | [`/category/list-by/city`](#GET-/category/list-by/city) | no | List all categories by city.
7+
| METHOD | URL | AUTH | USAGE |
8+
|--------|---------------------------------------------------------|------|------------------------------|
9+
| GET | [`/category/list-by/city`](#GET /category/list-by/city) | no | List all categories by city. |
1010

1111
### <a name="GET-/category/list-by/city"></a>GET `/category/list-by/city`
1212

1313
List all categories by city.
1414

1515
#### Request
1616

17-
MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
18-
--- | --- | --- | --- | ---
19-
QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI`
20-
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
21-
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
17+
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
18+
|-------|----------|--------|----------|--------------------------------------------------------------------------------------------------------------------|
19+
| QUERY | cityCode | string | no | The city code. Eg: `NEW_YORK`, `DUBAI` |
20+
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
21+
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
2222

2323
#### Response
2424

2525
**Object:** [`category`](/object-models/category-models.md#category)
2626

27-
```javascript
27+
```json
2828
{
2929
"items": [
3030
{

‎apis/city.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,26 @@
44

55
## APIs
66

7-
METHOD | URL | AUTH | USAGE
8-
--- | --- | --- | ---
9-
GET | [`/city`](#GET-/city) | no | List all the active cities.
7+
| METHOD | URL | AUTH | USAGE |
8+
|--------|-----------------------|------|-----------------------------|
9+
| GET | [`/city`](#GET~/city) | no | List all the active cities. |
1010

1111
### <a name="GET-/city"></a>GET `/city`
1212

1313
List all the active cities.
1414

1515
#### Request
1616

17-
MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
18-
--- | --- | --- | --- | ---
19-
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
20-
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
17+
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
18+
|-------|--------|--------|----------|--------------------------------------------------------------------------------------------------------------------|
19+
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
20+
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
2121

2222
#### Response
2323

2424
**Object:** [`city`](/object-models/common-models.md#city)
2525

26-
```javascript
26+
```json
2727
{
2828
"items": [
2929
{

‎apis/inventory-pricing.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@
44

55
## APIs
66

7-
METHOD | URL | AUTH | USAGE
8-
--- | --- | --- | ---
9-
GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant.
7+
| METHOD | URL | AUTH | USAGE |
8+
|--------|-----------------------------------------------------------------|------|--------------------------------------------|
9+
| GET | [`/inventory/list-by/variant`](#GET-/inventory/list-by/variant) | no | Get the available inventory for a variant. |
1010

1111
### <a name="GET-/inventory/list-by/variant"></a>GET `/inventory/list-by/variant`
1212

1313
Get the available inventory for a variant.
1414

1515
#### Request
1616

17-
MODE | KEY | TYPE | OPTIONAL | DESCRIPTION
18-
--- | --- | --- | --- | ---
19-
QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched.
20-
QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
21-
QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)*
22-
QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
23-
QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)*
24-
QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)*
17+
| MODE | KEY | TYPE | OPTIONAL | DESCRIPTION |
18+
|-------|---------------|--------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19+
| QUERY | variantId | string | no | The ID of the variant for which the inventory needs to be fetched. |
20+
| QUERY | startDateTime | string | yes | The start date time from which the inventory needs to be fetched. If unspecified then the current timestamp is taken into consideration. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
21+
| QUERY | endDateTime | string | yes | The end date time till which the inventory needs to be fetched. If unspecified then this is taken as infinity. *Format: [fm-date-time](/conventions/formats.md#fm-date-time)*. *Ref: [`inventory.startDateTime`](#inventory.startDateTime)* |
22+
| QUERY | offset | string | yes | The offset for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
23+
| QUERY | limit | int | yes | The limit for pagination. *Ref: [Pagination - Request Params](/conventions/basics.md#Pagination--Request-Params)* |
24+
| QUERY | currencyCode | string | yes | The currency in which pricing information will be returned. Eg: `USD`, `AED`. *Ref: [https://en.wikipedia.org/wiki/ISO_4217](https://en.wikipedia.org/wiki/ISO_4217)* |
2525

2626
#### Response
2727

2828
**Object:** [`pagination-wrapper`](/object-models/common-models.md#pagination-wrapper)`<`[`inventory`](/object-models/inventory-pricing-models.md#inventory)`>`
2929

30-
```javascript
30+
```json
3131
{
3232
"items": [
3333
{
34-
"id": "1212121"
34+
"id": "1212121",
3535
"startDateTime": "2017-03-30T15:30:00",
3636
"endDateTime": "2017-03-30T15:30:00",
3737
"availability": "LIMITED/UNLIMITED/CLOSED",

0 commit comments

Comments
 (0)