REST API GUIDE

airbnb-reviewsystem-service

Version: 1.0.7

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…

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the ReviewSystem Service’s REST API. This document is designed to provide a comprehensive guide to interfacing with our ReviewSystem Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the ReviewSystem Service via HTTP requests for purposes such as creating, updating, deleting and querying ReviewSystem objects.

Overview

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST It’s important to note that the ReviewSystem Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

Authentication And Authorization

To ensure secure access to the ReviewSystem service’s protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it’s important to note that access control varies across different routes:

Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

Token Locations

When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

Location Token Name / Param Name
Query access_token
Authorization Header Bearer
Header airbnb3-access-token
Cookie airbnb3-access-token

Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.

Api Definitions

This section outlines the API endpoints available within the ReviewSystem service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It’s important to understand the flexibility in how parameters can be included in requests to effectively interact with the ReviewSystem service.

This service is configured to listen for HTTP requests on port 3004, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

This service is accessible via the following environment-specific URLs:

Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

Query Parameters: Included directly in the URL’s query string.

Path Parameters: Embedded within the URL’s path.

Body Parameters: Sent within the JSON body of the request.

Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user’s session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user’s session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the ReviewSystem service’s API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

Common Parameters

The ReviewSystem service’s business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the ReviewSystem service.

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 within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

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

Object Structure of a Successfull Response

When the ReviewSystem service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

Key Characteristics of the Response Envelope:

Design Considerations: The structure of a API’s response data is meticulously crafted during the service’s architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

Brief Data: Certain API’s return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

HTTP Status Codes:

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. 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": []
}

Handling Errors:

For details on handling error scenarios and understanding the structure of error responses, please refer to the “Error Response” section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

Resources

ReviewSystem service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

ReviewAggregate resource

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

Name Type Required Default Definition
revieweeId ID **
revieweeType Enum **
averageRating Double **
reviewCount Integer **
visibilityStatus Enum **

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

revieweeType Enum Property

Enum Options

Name Value Index
host "host"" 0
guest "guest"" 1
listing "listing"" 2
visibilityStatus Enum Property

Enum Options

Name Value Index
public "public"" 0
hidden "hidden"" 1

Review resource

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

Name Type Required Default Definition
moderationStatus Enum **
isPublished Boolean **
reviewText Text **
rating Integer **
blindSubmissionCode String **
revieweeId ID **
reservationId ID **
reviewerId ID **
revieweeType Enum **
submittedAt Date **

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

moderationStatus Enum Property

Enum Options

Name Value Index
pending "pending"" 0
approved "approved"" 1
rejected "rejected"" 2
revieweeType Enum Property

Enum Options

Name Value Index
host "host"" 0
guest "guest"" 1
listing "listing"" 2

Business Api

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 regular request parameter

Parameter Type Required Population
reviewId ID true request.params?.[“reviewId”]
reviewId : This id paremeter is used to query the required data object.

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

Filter Parameters

The listReviewAggregates api supports 2 optional filter parameters for filtering list results:

revieweeId (ID): Filter by revieweeId

revieweeType (Enum): Filter by revieweeType

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: {
    
        // Filter parameters (see Filter Parameters section above)
        // revieweeId: '<value>' // Filter by revieweeId
        // revieweeType: '<value>' // Filter by revieweeType
            }
  });

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 regular request parameters

Parameter Type Required Population
moderationStatus Enum true request.body?.[“moderationStatus”]
isPublished Boolean true request.body?.[“isPublished”]
reviewText Text true request.body?.[“reviewText”]
rating Integer true request.body?.[“rating”]
revieweeId ID true request.body?.[“revieweeId”]
reservationId ID true request.body?.[“reservationId”]
revieweeType Enum true request.body?.[“revieweeType”]
moderationStatus :
isPublished :
reviewText :
rating :
revieweeId :
reservationId :
revieweeType :

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 regular request parameter

Parameter Type Required Population
reviewId ID true request.params?.[“reviewId”]
reviewId : This id paremeter is used to select the required data object that will be deleted

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 regular request parameter

Parameter Type Required Population
reviewAggregateId ID true request.params?.[“reviewAggregateId”]
reviewAggregateId : This id paremeter is used to query the required data object.

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

Filter Parameters

The listReviews api supports 4 optional filter parameters for filtering list results:

revieweeId (ID): Filter by revieweeId

reservationId (ID): Filter by reservationId

reviewerId (ID): Filter by reviewerId

revieweeType (Enum): Filter by revieweeType

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: {
    
        // Filter parameters (see Filter Parameters section above)
        // revieweeId: '<value>' // Filter by revieweeId
        // reservationId: '<value>' // Filter by reservationId
        // reviewerId: '<value>' // Filter by reviewerId
        // revieweeType: '<value>' // Filter by revieweeType
            }
  });

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 regular request parameters

Parameter Type Required Population
reviewId ID true request.params?.[“reviewId”]
moderationStatus Enum false request.body?.[“moderationStatus”]
isPublished Boolean false request.body?.[“isPublished”]
reviewText Text false request.body?.[“reviewText”]
reviewId : This id paremeter is used to select the required data object that will be updated
moderationStatus :
isPublished :
reviewText :

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"
	}
}

Authentication Specific Routes

Common Routes

Route: currentuser

Route Definition: Retrieves the currently authenticated user’s session information.

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response Returns the session object, including user-related data and token information.

{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}

Error Response 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Route: permissions

*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

Returns an array of permission objects.

[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]

Each object reflects a single permission grant, aligned with the givenPermissions model:

Error Responses

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

Route: permissions/:permissionName

Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

Parameter Type Required Population
permissionName String Yes request.params.permissionName

Behavior

// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

{
  "canDo": true,
  "exceptions": [
    "a1f2e3d4-xxxx-yyyy-zzzz-object1",
    "b2c3d4e5-xxxx-yyyy-zzzz-object2"
  ]
}

All sources, documents and other digital materials are copyright of .

About Us

For more information please visit our website: .

. .