AIRBNB

FRONTEND GUIDE FOR AI CODING AGENTS - PART 10 - ReviewSystem Service

This document is a part of a REST API guide for the airbnb project. It is designed for AI agents that will generate frontend code to consume the project’s backend.

This document provides extensive instruction for the usage of reviewSystem

Service Access

ReviewSystem service management is handled through service specific base urls.

ReviewSystem service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).

For the reviewSystem service, the base URLs are:

• Preview: https://airbnb3.prw.mindbricks.com/reviewsystem-api
• Staging: https://airbnb3-stage.mindbricks.co/reviewsystem-api
• Production: https://airbnb3.mindbricks.co/reviewsystem-api

Scope

ReviewSystem Service Description

Handles double-blind, moderated reviews and rating aggregation for stays. Allows guests/hosts to review each other and listings, supports moderation, and exposes aggregate stats for listings/profiles...

ReviewSystem service provides apis and business logic for following data objects in airbnb application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.

reviewAggregate Data Object: Cached aggregate rating stats for a listing, host, or guest. Used for fast lookup and display of averages, counts, etc.

review Data Object: Review submitted by a guest or host after a completed stay. Enables double-blind, supports moderation, and links to reservation/listing and users.

API Structure

Object Structure of a Successful Response

When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.

HTTP Status Codes:

• 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
• 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling that the request executed successfully. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3,
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation.

Additional Data

Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.

Error Response

If a request encounters an issue—whether due to a logical fault or a technical problem—the service responds with a standardized JSON error structure. The HTTP status code indicates the nature of the error, using commonly recognized codes for clarity:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters.
• 401 Unauthorized: The request lacked a valid authentication token; login is required.
• 403 Forbidden: The current token does not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition.

Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Bucket Management

(This information is also given in PART 1 prompt.)

This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.

Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.

User Bucket This bucket stores public user files for each user.

When a user logs in—or in the /currentuser response—there is a userBucketToken to use when sending user-related public files to the bucket service.

{
  //...
  "userBucketToken": "e56d...."
}

To upload a file

POST {baseUrl}/bucket/upload

The request body is form-data which includes the bucketId and the file binary in the files field.

{
    bucketId: "{userId}-public-user-bucket",
    files: {binary}
}

Response status is 200 on success, e.g., body:

{
    "success": true,
    "data": [
        {
            "fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
            "originalName": "test (10).png",
            "mimeType": "image/png",
            "size": 604063,
            "status": "uploaded",
            "bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
            "isPublic": true,
            "downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
        }
    ]
}

To download a file from the bucket, you need its fileId. If you upload an avatar or other asset, ensure the download URL or the fileId is stored in the backend.

Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.

Application Bucket

This Airbnb application also includes a common public bucket that anyone can read, but only users with the superAdmin, admin, or saasAdmin roles can write (upload) to it.

When a user with one of these admin roles is logged in, the /login response or the /currentuser response also returns an applicationBucketToken field, which is used when uploading any file to the application bucket.

{
  //...
  "applicationBucketToken": "e23fd...."
}

The common public application bucket ID is

"airbnb3-public-common-bucket"

In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.

Please configure your UI to upload files to the application bucket using this bucket token whenever needed.

Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.

These buckets will be used as described in the relevant object definitions.

ReviewAggregate Data Object

Cached aggregate rating stats for a listing, host, or guest. Used for fast lookup and display of averages, counts, etc.

ReviewAggregate Data Object Properties

ReviewAggregate data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• revieweeType: [host, guest, listing]

• visibilityStatus: [public, hidden]

Filter Properties

revieweeId revieweeType

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• revieweeId: ID has a filter named revieweeId

• revieweeType: Enum has a filter named revieweeType

Review Data Object

Review submitted by a guest or host after a completed stay. Enables double-blind, supports moderation, and links to reservation/listing and users.

Review Data Object Properties

Review data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.

• Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.

• moderationStatus: [pending, approved, rejected]

• revieweeType: [host, guest, listing]

Relation Properties

reservationId reviewerId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.

In frontend, please ensure that,

1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.

• reservationId: ID Relation to reservation.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

• reviewerId: ID Relation to user.id

The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.

Required: Yes

Filter Properties

revieweeId reservationId reviewerId revieweeType

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.

• revieweeId: ID has a filter named revieweeId

• reservationId: ID has a filter named reservationId

• reviewerId: ID has a filter named reviewerId

• revieweeType: Enum has a filter named revieweeType

API Reference

Get Review API

Retrieve a review and, if double-blind complete, return full info. Enrich with reviewer/reviewee & reservation if allowed by publish and moderation/business rules.

Rest Route

The getReview API REST controller can be triggered via the following route:

/v1/reviews/:reviewId

Rest Request Parameters

The getReview api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/reviews/:reviewId

  axios({
    method: 'GET',
    url: `/v1/reviews/${reviewId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "review",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"review": {
		"id": "ID",
		"moderationStatus": "Enum",
		"moderationStatus_idx": "Integer",
		"isPublished": "Boolean",
		"reviewText": "Text",
		"rating": "Integer",
		"blindSubmissionCode": "String",
		"revieweeId": "ID",
		"reservationId": "ID",
		"reviewerId": "ID",
		"revieweeType": "Enum",
		"revieweeType_idx": "Integer",
		"submittedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Reviewaggregates API

List aggregate rating stats for listings or user profiles (cache-friendly, e.g., for search results or admin export).

Rest Route

The listReviewAggregates API REST controller can be triggered via the following route:

/v1/reviewaggregates

Rest Request Parameters The listReviewAggregates api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/reviewaggregates

  axios({
    method: 'GET',
    url: '/v1/reviewaggregates',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "reviewAggregates",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"reviewAggregates": [
		{
			"id": "ID",
			"revieweeId": "ID",
			"revieweeType": "Enum",
			"revieweeType_idx": "Integer",
			"averageRating": "Double",
			"reviewCount": "Integer",
			"visibilityStatus": "Enum",
			"visibilityStatus_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Review API

Guest or host submits review for completed reservation. Double-blind: published after both reviews or expiry. Moderation applies. Only allowed if session.user is guest/host of reservation and not already reviewed.

Rest Route

The createReview API REST controller can be triggered via the following route:

/v1/reviews

Rest Request Parameters

The createReview api has got 7 request parameters

REST Request To access the api you can use the REST controller with the path POST /v1/reviews

  axios({
    method: 'POST',
    url: '/v1/reviews',
    data: {
            moderationStatus:"Enum",  
            isPublished:"Boolean",  
            reviewText:"Text",  
            rating:"Integer",  
            revieweeId:"ID",  
            reservationId:"ID",  
            revieweeType:"Enum",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "review",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"review": {
		"id": "ID",
		"moderationStatus": "Enum",
		"moderationStatus_idx": "Integer",
		"isPublished": "Boolean",
		"reviewText": "Text",
		"rating": "Integer",
		"blindSubmissionCode": "String",
		"revieweeId": "ID",
		"reservationId": "ID",
		"reviewerId": "ID",
		"revieweeType": "Enum",
		"revieweeType_idx": "Integer",
		"submittedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Review API

Allows hard or soft-delete of review pre-publish (reviewer) or at any time (admin/moderator). Deletion triggers aggregate recalc.

Rest Route

The deleteReview API REST controller can be triggered via the following route:

/v1/reviews/:reviewId

Rest Request Parameters

The deleteReview api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path DELETE /v1/reviews/:reviewId

  axios({
    method: 'DELETE',
    url: `/v1/reviews/${reviewId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "review",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"review": {
		"id": "ID",
		"moderationStatus": "Enum",
		"moderationStatus_idx": "Integer",
		"isPublished": "Boolean",
		"reviewText": "Text",
		"rating": "Integer",
		"blindSubmissionCode": "String",
		"revieweeId": "ID",
		"reservationId": "ID",
		"reviewerId": "ID",
		"revieweeType": "Enum",
		"revieweeType_idx": "Integer",
		"submittedAt": "Date",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Reviewaggregate API

Get aggregate rating stats for listing or user profile (fast lookup cache for UI display).

Rest Route

The getReviewAggregate API REST controller can be triggered via the following route:

/v1/reviewaggregates/:reviewAggregateId

Rest Request Parameters

The getReviewAggregate api has got 1 request parameter

REST Request To access the api you can use the REST controller with the path GET /v1/reviewaggregates/:reviewAggregateId

  axios({
    method: 'GET',
    url: `/v1/reviewaggregates/${reviewAggregateId}`,
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "reviewAggregate",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"reviewAggregate": {
		"id": "ID",
		"revieweeId": "ID",
		"revieweeType": "Enum",
		"revieweeType_idx": "Integer",
		"averageRating": "Double",
		"reviewCount": "Integer",
		"visibilityStatus": "Enum",
		"visibilityStatus_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Reviews API

List published/approved reviews for listing, host, or guest profile. Double-blind: only list reviews when available (both submitted or timer expired & published). Optional filters: revieweeId, revieweeType, reservationId.

Rest Route

The listReviews API REST controller can be triggered via the following route:

/v1/reviews

Rest Request Parameters The listReviews api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/reviews

  axios({
    method: 'GET',
    url: '/v1/reviews',
    data: {
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "reviews",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"reviews": [
		{
			"id": "ID",
			"moderationStatus": "Enum",
			"moderationStatus_idx": "Integer",
			"isPublished": "Boolean",
			"reviewText": "Text",
			"rating": "Integer",
			"blindSubmissionCode": "String",
			"revieweeId": "ID",
			"reservationId": "ID",
			"reviewerId": "ID",
			"revieweeType": "Enum",
			"revieweeType_idx": "Integer",
			"submittedAt": "Date",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Review API

Allows reviewer to edit own review before publish OR admin/mod to update moderation fields. Enforces state business rules.

Rest Route

The updateReview API REST controller can be triggered via the following route:

/v1/reviews/:reviewId

Rest Request Parameters

The updateReview api has got 4 request parameters

REST Request To access the api you can use the REST controller with the path PATCH /v1/reviews/:reviewId

  axios({
    method: 'PATCH',
    url: `/v1/reviews/${reviewId}`,
    data: {
            moderationStatus:"Enum",  
            isPublished:"Boolean",  
            reviewText:"Text",  
    
    },
    params: {
    
    }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "review",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"review": {
		"id": "ID",
		"moderationStatus": "Enum",
		"moderationStatus_idx": "Integer",
		"isPublished": "Boolean",
		"reviewText": "Text",
		"rating": "Integer",
		"blindSubmissionCode": "String",
		"revieweeId": "ID",
		"reservationId": "ID",
		"reviewerId": "ID",
		"revieweeType": "Enum",
		"revieweeType_idx": "Integer",
		"submittedAt": "Date",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.