NAV Navigation
Shell JSON

Review APIs

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This API provides the review and feedback data from the reputed customers. Review API is a Review data fetching service. Review Data consists of the Review content, NLP mood detection, NLP categorisation & polarization, scoring and sub scoring, author name, author category, author description, author country.

The Methods listed in this document are organized under the following Groups:

Group Definition
Authentication Gaining access to the API.
Account Viewing basic information about your query (henceforth referred to as 'call') settings.
Entity Information Search by hotel and retrieve information on the Review Data.
Schedules Set up a routine to run an Review Data Shop
Hooks Defines the end-point for the delivery of events or impact or demands retrieved by the Review API.
References Retrieves reference values used in ReviewAPI.

Authorization

Every request sent to the Reviews API must be authenticated with an access token. You can obtain an access token when you log-in using the credentials provided to you in your ReputationAPI packet. An access token is valid only for 24 hours from the time it is generated

The access token must be appended to the ‘Authorization Header’ as depicted in the example below: If ‘A90324XXZUZUgpO0dd6npHcM83CJ...' is your access token, every request must contain the following header:

Base URLs:

Request and Response Parameters

Common Request Header / Body / Query Parameters

The Request Header parameters is applicable to all other field attributes and features

Name Requirement
(True or False)
Data Type Description
Authorization Required String The JWT Token in format "Bearer xxxx.yyyy.zzzz"

The Request Body / Query parameters is applicable to all other field attributes and features.

Name In Requirement (True or False) Data Type Description
page query Optional/False Integer / Number Enter the page number with default value as 1
size query Optional/False Number/ integer Enter the size of data with the default value as 10

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Authentication

Auth & User Management

Every request is sent to the Reputation API must be authenticated with an access token. You can obtain an access token when you log-in using the credentials provided to you in your ReputationAPI packet. An access token is valid for 24 hours from the time it is generated.

The access token must be appended to the 'Authorization Header' as depicted in the example below: If 'A90324XXZUZUgpO0dd6npHcM83CJ...' is your access token, every request must contain the following header:

Authorization: Bearer A90324XXZUZUgpO0dd6npHcM83CJ...

This call authenticates the validity of a username/password combination. If the authentication is successful, a valid access token is issued.

Get User Login Authentication by Email and Password

This POST method searches for the matching user login credentials to authenticate / validate the credentials, based on the provided search key and the respective values passed, with Permission as PUBLIC.

Code samples

# You can also use wget
curl -X POST https://reviews.airfare-api.aggregateintelligence.com/docs/login \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

POST /auth/token

Validate login using username/password with clientid and return a JWT This call authenticates the validity of a handle/password combination. If the authentication is successful, a valid access token is issued.

Input Method - Resource URL

Base URLs

Request Body

Parameter Name Type Description Requirement (Optional or Mandatory)
username String Enter a username only Required / Mandatory
password String Enter a password Required / Mandatory

Sample Request (JSON Code Format Snippet)

{
"username": "string",
"password": "string"
}

Sample Response (JSON Code Format Snippet)

200 Response

{
"accessToken":"string",
"tokenType":"string"
"expiresIn":"0"
"userName":"string"
"fullName":"string"
"issued":"string"
"expires":"string"
}

Responses

Status Meaning Description Schema
200 OK Success UserResp
401 Unauthorized Authentication Failed None
404 Not Found User Not Found None

Entity Information

This module allows the API customer to check the availability of specific brands in the system. It allows the customer to request inclusion of new sources.

Entity Hotel Search

Sample Request (JSON Code Format Snippet)

{
    "term": "department Store",
    "city": "lNiaocheng",
    "state": "shandong",
    "country": "China",
    "zip": "252500",
    "geoLocationFilter": {
      "latitude": "36.45",
      "longitude": "115.99",
      "radius": "50km"
    },
    "limit": 100,
    "showHotelsWithNoReviews": false
  }
  

POST /entity/hotels

The hotel information is retrieved from elastic search including the reviews count. Plan is to show the overall data with booking source with the database and table information.

This POST method allows you to Search on Hotels from every angle (like geolocation & text based contain searches) and retrieve information (including count of reviews) regarding them.

POST /entity/hotels/search

Request: The user would request for the list of available Hotels, for that the input parameter would be location coordinates. The response should return on the runtime if available.

Response: Our API should give a list of all the available hotelcode, hotelname, and so on from the hotels database using the geolocation parameter

POST /entity/reviews/summary

The rating information such as the hotel rating, location rating, Staff rating are displayed in this section.

Database --> Hotelreviews_api

Table --> reviewdata_api

POST /entity/reviews/details

The rating information of the hotel, staff, services and the details are displayed in this section.

Sample Request (JSON Code Format Snippet)

[
    {
      "hotelcode": "1234567",
      "hotelname": "7Days Inn Liaocheng Department Sotre",
      "address": "East 100m to Liaocheng Department Sotre",
      "city": "Liaocheng",
      "state": "Shandong",
      "country": "China",
      "zip": "252500",
      "location": [
        {
          "latitude": "10.6305",
          "longitude": "76.9214"
        }
      ],
      "matchScore": 12.64333,
      "reviewsCount": 11
    }
  ]
  

Request Body Parameters

Name In Data object Data Type Requirement (True or False) Description
body body - true none
term - string required Find the hotels whose name, address, etc contain this string
city - string required Match the hotels in this city
state - string required Match the hotels in this state
country - string required Match the hotels in this country
zip - string required Match the hotels in this zip code (highest priority)
geolocationfilter - number required Restrict the number of matching hotels found to this limit
showHotelsWithNoReviews - boolean required Whether to include hotels which have no reviews in our DB

Code samples

# You can also use wget
curl -X POST https://reviews.airfare-api.aggregateintelligence.com/entity/hotels/search\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

Responses

Status Meaning Description Schema
200 OK Success -
400 - Validation Error -
401 Unauthorized Authorization Failed None

Entity Information Reviews Summary

Sample Request (JSON Code Format Snippet)

{
      "hotelCodes": [
        1,
        123
      ],
      "sourceCodes": [
        1,
        283
      ]
    }
    

This method allows you to fetch Reviews for a specific Hotel, optionally filtered by Review Source(s).

POST /entity/ratings [Aliased POST /entity/reviews/summary]

Request: The user would request the list of available hotel ratings/scores. The input parameters should be hotelcode and website and clientid. The response should return on the runtime if available.

Response: The format of the resulting json should be a single json.

POST /entity/reviews [Aliased POST /entity/reviews/details]

Request: The user would request the list of available hotel reviews.The input parameters should be hotelcode and website and clientid. The response should return on the runtime if available.

Request: The format of the resulting json should be a single json. It shall be paginated, with same default limits.

Sample Request (JSON Code Format Snippet)

[
      {
        "hotelCode": "999184",
        "hotelName": "7Days Inn Liaocheng Department Sotre",
        "address": "East 100m to Liaocheng Department Sotre",
        "city": "Liaocheng",
        "state": "Shandong",
        "country": "China",
        "location": {
          "latitude": "10.6305",
          "longitude": "76.9214"
        },
        "zip": "252500",
        "reviewSummary": [
          {
            "hotelCode": "3399075",
            "source": 284,
            "scoreHotel": 4.3,
            "scoreLocation": 4.5,
            "scoreStaff": 4.3,
            "scoreCleanliness": 4.2,
            "scoreValueForMoney": 4.2,
            "scoreComfort": 4.2,
            "scoreFacilities": 4.2,
            "scoreFreeWiFi": 4.2,
            "hotelReviewNbr": 123,
            "scoreService": 4.2,
            "collectionDate": "2023-04-18T09:44:44.656Z",
            "outOfReview": 5,
            "guestsChoice": 5,
            "hotelCondition": 5,
            "reviewUrl": 5,
            "dtCollected": "01-01-2022.14:15:00",
            "service": 5,
            "sourceHotelCode": 5,
            "starRating": 5,
            "rank": 5,
            "city": 5,
            "websiteName": "Google"
          }
        ]
      }
    ]
    

Request Body Parameters

Name In Data Type Requirement (True or False) Description
body body - true None
hotelcodes - number required Unique code of the hotel to fetch reviews for (as obtained e.g from POST /entity/hotels)
sourcecodes - number required Optionally filter by reviews from these specific website/sources only (as obtained from GET /references/sources). By default, it will fetch from all sources available.

Responses

Status Meaning Description Schema
200 OK Success -
400 - Validation Error -
401 Unauthorized Authorization Failed None

Entity Information Reviews Details

Sample Request (JSON Code Format Snippet)

{
          "hotelCode": "1234567",
          "sourceCodes": [
            1,
            283
          ],
          "reviewDateFilter": {
            "start": "12/30/2022",
            "end": "12/23/2023"
          },
          "limit": 5000,
          "offset": 0
        }
        

This method allows you to fetch Reviews for a specific Hotel, optionally filtered by Review Source(s).

/entity/reviews/details/

The detailed information of reviews from the customers can be retrieved in this section.

Database --> Hotelreviews_api

Table --> reviewdetails_api

This method should allow the API customer to check the availability of specific hotels and reviews in the system, through a search with summary details.

POST /entity/reputation/hotels

Request: The user would access hotel ratings and reviews daily for new reviews added and ratings updated for the sources referenced. The input parameters should be hotelcode clientname.(SinceDate and StartDate, Enddate logic is used).

Response: The format of the resulting json should be a single json

Request Body Parameters

Sample Request (JSON Code Format Snippet)

{
          "hotelCode": "3399075",
          "hotelName": "7Days Inn Liaocheng Department Sotre",
          "address": "East 100m to Liaocheng Department Sotre",
          "city": "Liaocheng",
          "state": "Shandong",
          "country": "China",
          "location": "10.2688,77.4914",
          "zip": "252500",
          "reviewsDetails": [
            {
              "uniqueId": 123,
              "reviewID": "123abc",
              "reviewContent": "123abc",
              "reviewContentPos": "123abc",
              "reviewContentNeg": "123abc",
              "reviewContentNeu": "123abc",
              "cleanReviewContent": "123abc",
              "cleanReviewContentPos": "123abc",
              "cleanReviewContentNeg": "123abc",
              "cleanReviewContentNeu": "123abc",
              "sentimentScore": 4.5,
              "outOfReview": 4,
              "properties": "123abc",
              "author": "123abc",
              "authorCategory": "123abc",
              "authorCountry": "123abc",
              "reviewHeader": "123abc",
              "reviewedDate": "123abc",
              "reviewerType": "123abc",
              "reviewScore": "123abc",
              "location": "123abc",
              "reviewsCount": "123abc",
              "replyFromHotel": "123abc",
              "dtCollected": "123abc",
              "language": "123abc",
              "reviewId": "123abc",
              "serviceRating": "123abc",
              "valueRating": "123abc",
              "sleepQualityRating": "123abc",
              "cleanlinessRating": "123abc",
              "locationRating": "123abc",
              "roomsRating": "123abc",
              "inputUrl": "123abc",
              "respondUrl": "123abc",
              "languageName": "123abc",
              "websiteName": "123abc",
              "polarity": "123abc",
              "sourceHotelCode": "123abc"
            }
          ]
        }
        
Name In Data Type Requirement (True or False) Description
body body - true None
hotelcodes - required string Unique code of the hotel to fetch reviews for (as obtained e.g from POST /entity/hotels)
sourcecodes - required number Optionally filter by reviews from these specific website/sources only (as obtained from GET /references/sources). By default, it will fetch from all sources available.
reviewdatefilter - required String Specified date should be MM/DD/YYYY format
Specified date should be MM/DD/YYYY format. Note that, if unspecified, this default is today's date
limit - required number Limit the number of reviews to be shown. Note that, the reviews are always sorted by collection date (latest first).
offset - required number Number of records to be displayed on the result

Responses

Success Response code is 200

Status Meaning Description Schema
200 OK Success -
400 - Validation Error -
401 Unauthorized Authorization Failed None

References

This section mostly includes the endpoints to fetch all static data available in our DB. The info these endpoints provide (specifically, the _id fields) are used with the other endpoints as input parameters.

Reference Sources

GET /reference/sources

Sample Request (JSON Code Format Snippet)

[
  {
    "sourceCode": 1,
    "sourceName": "expedia",
  },
  {
    "sourceCode": 2,
    "sourceName": "booking.com",
  },
  {
    "sourceCode": 3,
    "sourceName": "makemytrip",
  },
  {
    "sourceCode": 5,
    "sourceName": "agoda",
  },
 {
    "sourceCode": 7,
    "sourceName": "goibibo",
  },
 {
    "sourceCode": 12,
    "sourceName": "hotels_com",
  },
 {
    "sourceCode": 261,
    "sourceName": "yatra",
  },
 {
    "sourceCode": 283,
    "sourceName": "google",
  },
 {
    "sourceCode": 285,
    "sourceName": "airbnb",
  },
 {
    "sourceCode": 324,
    "sourceName": "tripadvisor",
  },
 {
    "sourceCode": 3663,
    "sourceName": "facebook",
  },

]

Responses

Success Response code is 200

Status Meaning Description Schema
200 OK success -
400 - Validation Error -
401 Unauthorized Authorization Failed none

Sample Request (JSON Code Format Snippet)

[
  {
    "sourceCode": 1,
    "sourceName": "expedia",
    "displayName": "Expedia"
  }
]

Review Schedules

This method allows you to create schedule with review shop Id

Sample Request (JSON Code Format Snippet)

{
    "shopId": 1234,
    "deliveryDay": [
      0,
      1
    ],
    "deliveryTime": "23:45:56"
  }
  

POST /schedule - Set up a routine to run a defined reviewshop. This API call creates a timetable for running a specific review shop at a predetermined date and time on a set schedule.

GET /schedules?sid=xxx - List out all schedules defined for the current user. Filterable by shop id

GET /schedule/{scheduleId} - Fetch details of a single defined schedule

PUT /schedule/{scheduleId} - Edit details of a single defined schedule

DEL /schedule/{scheduleId} - Delete a single defined schedule

Schedule information with hotelcodes and websitecodes. Need to change the request like below module.

{
  "schedulename": X-Mas,
  "shopid": 0,
  "year": "",
  "month": "",
  "dow": "",
  "day": "",
  "status": "1",
  "deliveryTime": "23:45:56",
  "startdate": "2023-01-03",
  "enddate": "2023-01-03",
}

Database --> Hotelreviews_api

Table --> schedules

Add New Schedule

To add a new schedule using the POST method, with review shop id.

/schedule

Sample Request (JSON Code Format Snippet)

https://reviews.airfare-api.aggregateintelligence.com/schedule

Code samples

# You can also use wget
curl -X POST 'https://reviews.airfare-api.aggregateintelligence.com/schedule' \
-H 'accept: application/json' \
-H ''Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6Imdva3VsQGFnZ3JlZ2F0ZWludGVsbGlnZW5jZS5pbiIsInVzZXJJZCI6ImNsM2NrNTNwajAwMDBneXc1ZGhsejE1azkiLCJmdWxsTmFtZSI6Ikdva3VsIFIiLCJ0aW1lIjoiMjAyMy0wNC0wM1QwNDozNDoyOC4wMTBaIiwiaWF0IjoxNjgwNDk2NDY4LCJleHAiOjE2ODA1ODI4Njh9.ZPG9bVNtAUwu3c7cPn2TF7xaLrjx43f2ZMK9_KHhcMI'\
-H 'Content-Type: application/json' \
-d '{'
"shopId" : 1234,
"deliveryDay" : '[' 0,
1,']' ,
"deliveryTime" : 23:45:56
'}'

Request Body Parameters

Name Requirement (True or False) Data Type Description
Shop id required number Unique code of the shopId which match from shops
deliveryDay required date Delivery day must be within 0 to 6 (0 means Sunday,....., 6 means Saturday)
deliveryTime required time Delivery Time must be in 24 hrs and format must be HH:mm:ss or HH:mm

Sample Request (JSON Code Format Snippet)

{
    "shopId": 1234,
    "deliveryDay": [
      0,
      1
    ],
    "deliveryTime": "23:45:56"
  }
  

Success Response is 200

Status Meaning Description Schema
200 OK, Shop created success -
401 Authorization Authorization Failed None

Sample Request (JSON Code Format Snippet)

{
      "error": true,
      "reason": "sid must be an integer value",
    }
    

Details Schedule

Code samples

# You can also use wget
curl -X GET https://reviews.airfare-api.aggregateintelligence.com/schedule/list{hooksId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'

To use the GET method and with permission as user; to fetch all the schedule details. No Parameters.

Request Query Parameters

Sample Request (JSON Code Format Snippet)

{
"result":[ { "scheduleId": 21, "sid": 10, "deliveryDay": 21, "deliveryTime": "04:00:00", "createdDate": "2022-11-02T05:14:02.780Z", "updateDate": null, } { "scheduleId": 23, "sid": 17, "deliveryDay": "3.4", "deliveryTime": "04:00:00", "createdDate": "2022-11-09T12:45:30.857Z", "updateDate": "2022-11-09T12:54:19.963Z", } { "scheduleId": 24, "sid": 15, "deliveryDay": "4.5", "deliveryTime": "04:00:00", "createdDate": "2022-11-09T12:49:16.553Z", "updateDate": "null", } { "scheduleId": 26, "sid": 1, "deliveryDay": "0.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-10T06:37:06.217Z", "updateDate": "null", } { "scheduleId": 27, "sid": 24, "deliveryDay": "0.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-10T08:09:50.367Z", "updateDate": "null", } { "scheduleId": 28, "sid": 46, "deliveryDay": "0.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-16T04:39:03.560Z", "updateDate": "null", } { "scheduleId": 29, "sid": 43, "deliveryDay": "0.1", "deliveryTime": "23:45:56", "createdDate": "2022-11-16T04:41:24.250Z", "updateDate": "2022-11-24T08:52:32.680Z", } { "scheduleId": 30, "sid": 23, "deliveryDay": "1.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-16T11:11:54.150Z", "updateDate": "null", } { "scheduleId": 31, "sid": 22, "deliveryDay": "1", "deliveryTime": "04:00:00", "createdDate": "2022-11-16T11:11:54.150Z", "updateDate": "null", } { "scheduleId": 32, "sid": 21, "deliveryDay": "1", "deliveryTime": "04:00:00", "createdDate": "2022-11-17T07:37:21.233Z", "updateDate": "null", } { "scheduleId": 33, "sid": 47, "deliveryDay": "0.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-17T07:37:21.233Z", "updateDate": "null", } { "scheduleId": 34, "sid": 20, "deliveryDay": "1.1", "deliveryTime": "04:00:00", "createdDate": "2022-11-17T08:09:13.797Z", "updateDate": "null", } { "scheduleId": 35, "sid": 18, "deliveryDay": "1", "deliveryTime": "04:00:00", "createdDate": "2022-11-17T08:55:07.343Z", "updateDate": "null", } { "scheduleId": 36, "sid": 19, "deliveryDay": "1", "deliveryTime": "04:00:00", "createdDate": "2022-11-17T09:01:42.550Z", "updateDate": "null", } { "scheduleId": 38, "sid": 14, "deliveryDay": "0", "deliveryTime": "04:00:00", "createdDate": "2022-11-23T12:19:58.737Z", "updateDate": "null", } { "scheduleId": 39, "sid": 62, "deliveryDay": "3.4", "deliveryTime": "04:00:00", "createdDate": "2022-11-09T12:45:30.857Z", "updateDate": "2022-11-09T12:54:19.963Z", } { "scheduleId": 40, "sid": 17, "deliveryDay": "4,6,0", "deliveryTime": "13:00:00", "createdDate": "2022-11-24T07:33:08.703Z", "updateDate": "null", } { "scheduleId": 41, "sid": 69, "deliveryDay": "0.1", "deliveryTime": "13:00:00", "createdDate": "2022-11-24T07:34:01.643Z", "updateDate": "null", } { "scheduleId": 42, "sid": 66, "deliveryDay": "1", "deliveryTime": "23:45:12", "createdDate": "2022-11-24T08:50:41.730Z", "updateDate": "null", } { "scheduleId": 43, "sid": 64, "deliveryDay": "1", "deliveryTime": "22:00:00", "createdDate": "2022-11-24T10:39:49.933Z", "updateDate": "null", } { "scheduleId": 44, "sid": 65, "deliveryDay": "1", "deliveryTime": "23:22:00", "createdDate": "2022-11-09T12:45:30.857Z", "updateDate": "null", } { "scheduleId": 45, "sid": 67, "deliveryDay": "1", "deliveryTime": "23:22:00", "createdDate": "2022-11-24T10:44:32.807Z", "updateDate": "null", } { "scheduleId": 46, "sid": 60, "deliveryDay": "1.2", "deliveryTime": "23:22:00", "createdDate": "2022-11-24T10:44:46.107Z", "updateDate": "null", } { "scheduleId": 47, "sid": 59, "deliveryDay": "0.", "deliveryTime": "23:45:56", "createdDate": "2022-11-24T10:45:50.173Z", "updateDate": "2022-11-24T10:50:30.153Z", } { "scheduleId": 48, "sid": 86, "deliveryDay": "0,2,4,1", "deliveryTime": "00:00:00", "createdDate": "2022-11-24T10:55:18.403Z", "updateDate": "null", } { "scheduleId": 49, "sid": 91, "deliveryDay": "1", "deliveryTime": "23:45:56", "createdDate": "2022-11-24T12:02:15.627Z", "updateDate": "null", } { "scheduleId": 50, "sid": 92, "deliveryDay": "1", "deliveryTime": "22:00:00", "createdDate": "2022-11-24T12:07:50.827Z", "updateDate": "null", } { "scheduleId": 51, "sid": 93, "deliveryDay": "6.1", "deliveryTime": "22:00:00", "createdDate": "2022-11-24T12:10:28.053Z", "updateDate": "null", } { "scheduleId": 52, "sid": 94, "deliveryDay": "1.2", "deliveryTime": "22:00:00", "createdDate": "2022-11-24T12:12:02.630Z", "updateDate": "2022-11-24T12:22:18.020Z", } { "scheduleId": 53, "sid": 106, "deliveryDay": "1,2,0,3", "deliveryTime": "23:11:00", "createdDate": "2022-11-25T07:16:49.250z", "updateDate": "2022-11-25T07:33:37.347Z", } { "scheduleId": 54, "sid": 107, "deliveryDay": "1,0,2,4", "deliveryTime": "23:59:00", "createdDate": "2022-11-25T07:20:47.397Z", "updateDate": "null", } { "scheduleId": 60, "sid": 101, "deliveryDay": "0.1", "deliveryTime": "23:45:56", "createdDate": "2022-11-25T08:06:15.003Z", "updateDate": "2022-12-16T08:53:56.747Z", } { "scheduleId": 70, "sid": 109, "deliveryDay": "1", "deliveryTime": "23:45:56", "createdDate": "2022-11-25T10:00:06.777Z", "updateDate": "2022-11-25T10:01:03.977Z", } { "scheduleId": 99, "sid": 136, "deliveryDay": "1", "deliveryTime": "22:23:22", "createdDate": "2022-12-13T05:02:17.387Z", "updateDate": "null", } ] }

Success Response code is 200

Status Meaning Description Schema
200 OK success -

List Schedules

To use the GET method and with permission as user; to fetch particular schedule’s details.

/schedules

Parameters

Name In Data Type Requirement (True or False) Description
sid - integer Required Enter the shop schedule id

Success Response code is 200

Status Meaning Description Schema
200 OK OK schedule created none
401 Unauthorized Authorization Failed None

Update Schedule

To use the PUT method with permission as user; this is to particularly update specific schedule’s details..

/hook

Sample Response (JSON Code Format Snippet)

{
"deliveryDay":[ 0, 1, ], "deliveryTime":"23:45:56", }

Request Body Parameters

Name Requirement (True or False) Data Type Description
sid required string Enter the name of the shop schedule id to update
Data Required Object Enter the delivery date and delivery time
Delivery Day required number Delivery Day must be within 0 to 6 (0 means Sunday,.., 6 means Saturday)
Delivery Time required date Delivery Time must be in 24 hrs and format must be HH:mm:ss or HH:mm

Success Response code is 200

Status Meaning Description Schema
200 OK OK schedule updated none
401 Unauthorized Authentication Failed None

Delete Schedule

Delete Method with permission as user; to delete a particular / specific schedule’s details.

/schedule/:id

Request Body Parameters

Name Requirement (True or False) Data Type Description
sid required string Enter the name of the shop schedule id to delete

Success Response code is 200

Status Meaning Description Schema
200 OK OK Data Deleted none
401 Unauthorized Authentication Failed None

Review Shops

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This method allows you to create shop with review shop Id. Shop information with hotel codes and website codes. Need to remove the limit key from this request.

Database --> Hotelreviews_api

Table --> shops

CRUD routes for the shops

This should allow the API user to create the schedule for the review shop and should be able to create or edit or delete a new shop using the review shop ID.

● POST /shop - Creates a new shop

Request: Same as Hotel Search Entity with HotelName and address with clientid. Response: {sid} -> unique ID of the newly created shop

● GET /shops - List out all defined shop for current user (Details of Clients)

● GET /shop/{sid} - Get details of a particular shop (Particular Clients)

● PUT /shop/{sid} - Edit details of a particular Reviewshop (Editing Clients)

● DEL /shop/{sid} - Delete a particular Reviewshop (Deleting Clients)

GET /runshop/{sid} - “Run” a given shop immediately Response: Returns the reviewsdata in scheduled time if it is available in the table, Also if not available on the table then it will appear on the scheduled time of 24 hours.

Add New Shop

Sample Request (JSON Code Format Snippet

{
      "hotelCodes": [
      1,
      123
        ],
      "sourceCodes": [
      1,
      283
        ],
      "shopName": "Abc",
      "reviewsLimit": 100
      }
      

The POST method is used with permission as user; to add a new shop. This method allows you to create a new shop with review shop Id.

/shop

Request Body Parameters

Parameter Name Requirement (Optional or Mandatory) Type Description
data Required object -
Hotel codes Required Number Hotel codes must be an array
Source codes Required Number Shows the list of source codes in an array
Shop name Required string Shows the list of shop's names
Reviews limit Required Number Limit the number of reviews to be shown

Sample Request (JSON Code Format Snippet

{
      "message": "Shops details insert successfully with sid: 150",
      }
      

Success Response code is 200

Status Meaning Description Schema
200 OK Shop created Success -
401 Unauthorized Authentication Failed None

List Shop

https://reviews.airfare-api.aggregateintelligence.com/shop/List

To use the GET Method with permission as user to fetch /retrieve all the shop details. No Parameters are passed.

ref/aircrafts/

Success Response - 200

Status Meaning Description Schema
200 OK Shop details listed Success -
400 - Validation Error None
401 Unauthorized Authorization Failed -

Sample Response (JSON Code Format Snippet)

{
"result":[ { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "RS-19", "reviewsLimit": 100, "shopid": 1, "userId": null, } { "hotelCodes": "11", "sourceCodes": "11", "shopName": "aaaa", "reviewsLimit": 10, "shopid": 2, "userId": null, } { "hotelCodes": "9876", "sourceCodes": "24", "shopName": "ablion", "reviewsLimit": 100, "shopid": 3, "userId": null, } { "hotelCodes": "1111", "sourceCodes": "24", "shopName": "ablion", "reviewsLimit": 100, "shopid": 4, "userId": null, } { "hotelCodes": "111", "sourceCodes": "24", "shopName": "ablion", "reviewsLimit": 100, "shopid": 5, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 6, "userId": null, } { "hotelCodes": "3333", "sourceCodes": "24", "shopName": "aaaa", "reviewsLimit": 100, "shopid": 7, "userId": null, } { "hotelCodes": "1,123,456", "sourceCodes": "1,283", "shopName": "TESt", "reviewsLimit": 100, "shopid": 8, "userId": null, } { "hotelCodes": "4536,4959,5768", "sourceCodes": "1,34", "shopName": "simico", "reviewsLimit": 157, "shopid": 9, "userId": null, } { "hotelCodes": "999184,993408", "sourceCodes": "1,50", "shopName": ""millinium City", "reviewsLimit": 1000, "shopid": 10, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 11, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "ambija", "reviewsLimit": 100, "shopid": 12, "userId": null, } { "hotelCodes": "1435,3745", "sourceCodes": "1,283", "shopName": "sidco global tower", "reviewsLimit": 100, "shopid": 13, "userId": null, } { "hotelCodes": "xy", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 14, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 15, "userId": null, } { "hotelCodes": "1", "sourceCodes": "xy", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 16, "userId": null, } { "hotelCodes": "1.23", "sourceCodes": "1", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 17, "userId": null, } { "hotelCodes": "1.23,2.34", "sourceCodes": "1", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 18, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1.23,2.34", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 19, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "", "reviewsLimit": 100, "shopid": 20, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "abc", "reviewsLimit": 100, "shopid": 21, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "abc", "reviewsLimit": 100", "shopid": 22, "userId": null, } { "hotelCodes": "1.1", "sourceCodes": "2,2", "shopName": "", "reviewsLimit": 10, "shopid": 23, "userId": null, } { "hotelCodes": "1.1", "sourceCodes": "2.2", "shopName": "abc", "reviewsLimit": 10, "shopid": 24, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "abc", "reviewsLimit": 10, "shopid": 25, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "NA1", "reviewsLimit": 100, "shopid": 26, "userId": null, } { "hotelCodes": "1.99,xy", "sourceCodes": "1.99,xy", "shopName": "abc", "reviewsLimit": 10, "shopid": 27, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "abc", "reviewsLimit": 100, "shopid": 28, "userId": null, } { "hotelCodes": "1.99,xy", "sourceCodes": "1.99,xy", "shopName": "1", "reviewsLimit": 10, "shopid": 30, "userId": null, } { "hotelCodes": "1", "sourceCodes": "2", "shopName": "", "reviewsLimit": 10, "shopid": 31, "userId": null, } { "hotelCodes": "1", "sourceCodes": "2", "shopName": "", "reviewsLimit": 10, "shopid": 32, "userId": null, } { "hotelCodes": "8888,9999", "sourceCodes": "10,34", "shopName": "asd", "reviewsLimit": 100, "shopid": 33, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 34, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 35, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 36, "userId": null, } { "hotelCodes": "1.1", "sourceCodes": "1", "shopName": "agm", "reviewsLimit": 100, "shopid": 37, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "11111,9999", "shopName": "agm", "reviewsLimit": 100, "shopid": 38, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 39, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "www", "reviewsLimit": 100, "shopid": 40, "userId": null, } { "hotelCodes": "1,2", "sourceCodes": "1,2", "shopName": "", "reviewsLimit": 10, "shopid": 41, "userId": null, } { "hotelCodes": "1,1,2,2,3,3,4,4,", "sourceCodes": "1,22,333,4,4", "shopName": "abc", "reviewsLimit": 100, "shopid": 42, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "", "reviewsLimit": 100, "shopid": 43, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 44, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 45, "userId": null, } { "hotelCodes": "11111,9999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 46, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 47, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 48, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 49, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "", "reviewsLimit": 1, "shopid": 50, "userId": null, } { "hotelCodes": "-1", "sourceCodes": "-1", "shopName": "test-1", "reviewsLimit": -1, "shopid": 51, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 52, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 53, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 54, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 55, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 56, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 57, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 58, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 59, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 60, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "Text", "reviewsLimit": 11, "shopid": 61, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-S1", "reviewsLimit": 10, "shopid": 62, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-S1", "reviewsLimit": 10, "shopid": 63, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-S1", "reviewsLimit": 10, "shopid": 64, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,123", "shopName": "RS-19", "reviewsLimit": 100, "shopid": 65, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-S1", "reviewsLimit": 10, "shopid": 66, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-S1", "reviewsLimit": 10, "shopid": 67, "userId": null, } { "hotelCodes": "2345678", "sourceCodes": "1.27", "shopName": "Webel it park", "reviewsLimit": 150, "shopid": 68, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 69, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 70, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 71, "userId": null, } { "hotelCodes": "_1", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 72, "userId": null, } { "hotelCodes": "xy", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 73, "userId": null, } { "hotelCodes": "493211", "sourceCodes": "1,283", "shopName": "NA", "reviewsLimit": 100, "shopid": 74, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 75, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 76, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc26", "reviewsLimit": 100, "shopid": 77, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "1", "reviewsLimit": 100, "shopid": 78, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 79, "userId": null, } { "hotelCodes": "1,1", "sourceCodes": "1,283", "shopName": "abc", "reviewsLimit": 100, "shopid": 80, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "", "reviewsLimit": 100, "shopid": 81, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "_qwe", "reviewsLimit": 100, "shopid": 82, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "_qwe", "reviewsLimit": 100, "shopid": 83, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "qwe", "reviewsLimit": 100, "shopid": 84, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "qe", "reviewsLimit": 100, "shopid": 85, "userId": null, } { "hotelCodes": "1,2", "sourceCodes": "1,2", "shopName": "xyz", "reviewsLimit": 100, "shopid": 86, "userId": null, } { "hotelCodes": "1,2,3,4", "sourceCodes": "1,22,33,4", "shopName": "abc", "reviewsLimit": 100, "shopid": 87, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 89, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "", "reviewsLimit": 10, "shopid": 90, "userId": null, } { "hotelCodes": "1,2,2,2", "sourceCodes": "1,2,2,2", "shopName": "xy1", "reviewsLimit": 10, "shopid": 91, "userId": null, } { "hotelCodes": "11111,9999,11111", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 92, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "1111,999", "shopName": "agm", "reviewsLimit": 100, "shopid": 93, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "agm", "reviewsLimit": 100, "shopid": 94, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "_", "reviewsLimit": 100, "shopid": 95, "userId": null, } { "hotelCodes": "11111,999", "sourceCodes": "10,34", "shopName": "qe", "reviewsLimit": 100, "shopid": 96, "userId": null, } { "hotelCodes": "-11111,999", "sourceCodes": "10,34", "shopName": "qe", "reviewsLimit": 100, "shopid": 97, "userId": null, } { "hotelCodes": "0", "sourceCodes": "0", "shopName": "1", "reviewsLimit": 0, "shopid": 98, "userId": null, } { "hotelCodes": "1,2,6,0", "sourceCodes": 1,2,6,0", "shopName": "xy", "reviewsLimit": 100, "shopid": 99, "userId": null, } { "hotelCodes": "2365997", "sourceCodes": "1,283", "shopName": "pa", "reviewsLimit": 100, "shopid": 100, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 101, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-s1", "reviewsLimit": 100, "shopid": 102, "userId": null, } { "hotelCodes": "1", "sourceCodes": "1", "shopName": "RS-s1", "reviewsLimit": 100, "shopid": 103, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1", "shopName": "RS-s1", "reviewsLimit": 100, "shopid": 104, "userId": null, } { "hotelCodes": "1,2,6,0", "sourceCodes": "1", "shopName": "xy", "reviewsLimit": 100, "shopid": 105, "userId": null, } { "hotelCodes": "1,2,6,0", "sourceCodes": "1", "shopName": "xy", "reviewsLimit": 100, "shopid": 106, "userId": null, } { "hotelCodes": "1,2,6,0", "sourceCodes": "1", "shopName": "xy", "reviewsLimit": 100, "shopid": 107, "userId": null, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "RS-19", "reviewsLimit": 100, "shopid": 109, "userId": null, } { "hotelCodes": "99", "sourceCodes": "1,283", "shopName": "gopal", "reviewsLimit": 100, "shopid": 130, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "99184", "sourceCodes": "2", "shopName": "achintya", "reviewsLimit": 100, "shopid": 134, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "99184", "sourceCodes": "2", "shopName": "achintya", "reviewsLimit": 100, "shopid": 135, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "99184", "sourceCodes": "2", "shopName": "achintya", "reviewsLimit": 100, "shopid": 136, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111", "sourceCodes": "2", "shopName": "wwww", "reviewsLimit": 100, "shopid": 139, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111", "sourceCodes": "2", "shopName": "eeee", "reviewsLimit": 100, "shopid": 140, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111", "sourceCodes": "2", "shopName": "rrrr", "reviewsLimit": 100, "shopid": 141, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111", "sourceCodes": "2", "shopName": "tttt", "reviewsLimit": 100, "shopid": 142, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111", "sourceCodes": "2", "shopName": "yyyy", "reviewsLimit": 100, "shopid": 143, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111,2222,3333", "sourceCodes": "2,3,4,5,6", "shopName": "uuuu", "reviewsLimit": 100, "shopid": 144, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111,2222,3333", "sourceCodes": "2,3,4,5,6", "shopName": "uuuu", "reviewsLimit": 100, "shopid": 145, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1111,2222,3333", "sourceCodes": "2,3,4,5,6", "shopName": "uuuu", "reviewsLimit": 100, "shopid": 146, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "dummy-shop-001", "reviewsLimit": 100, "shopid": 147, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "dummy-shop-002", "reviewsLimit": 100, "shopid": 148, "userId": cl3ck53pj0000gyw5dhlz15k9, } { "hotelCodes": "288084,1071202", "sourceCodes": "1,283", "shopName": "test", "reviewsLimit": 100, "shopid": 149, "userId": clfjnyrku0000jbpacs3uaf6i, } { "hotelCodes": "1,123", "sourceCodes": "1,283", "shopName": "Abc", "reviewsLimit": 100, "shopid": 150, "userId": cl3ck53pj0000gyw5dhlz15k9, } ] }

Details Shop

To use the GET Method with permission as user to fetch/retrieve particular shop details.

/schedule/:id

Request Body Parameters

Name Requirement (True or False) Data Type Description
sid required number Enter the name of the shop id to update

Success Response - 200

Status Meaning Description Schema
200 OK OK shop details are shown none
401 Unauthorized Authentication Failed none

Update Shop

To use the PUT method, to update the shop details. This method allows you to create the schedule for the review shop and should be able to create or edit or delete a new shop using the review shop ID.

/shop/:id

Sample Request (JSON Code Format Snippet

{
  "hotelCodes": [
  1,
  123
    ],
  "sourceCodes": [
  1,
  283
    ],
  "shopName": "Abc",
  "reviewsLimit": 100
  }
  

Request Body Parameters

Parameter Name Requirement (Optional or Mandatory) Type Description
sid required integer Enter the shop id
data required object -
Hotel codes required Number Hotel codes must be an array
Source codes required Number Shows the list of source codes in an array
Shop name required string Shows the list of shop’s names
Reviews limit required Number Limit the number of reviews to be shown

Delete Shop

To use the Delete Method, to delete the shop details. This method allows you to delete a new shop using the review shop ID.

/shop/:id

Request Body Parameters

Parameter Name Requirement (Optional or Mandatory) Type Description
sid required integer Enter the shop id

Success Response is 200

Status Meaning Description Schema
200 OK data deleted Success -
401 Unauthorized Authorization Failed -

New Hotel Requests

New hotel requests works based on the Reviewshop

POST /entity/addhotels

Request params : A non-empty array of valid hotel codes

Response : 202 Accepted