Rating System API


The API defines methods to manage your Rating and Review and/or Questions and Answers, operate on them and perform searches, etc.

All calls should be made to your specific private API url (which we'll provide you).

Every call will report its success via the HTTP status code returned. If the status code is 4xx or 5xx then the response body may contain a plain error message providing further details. If a 2xx code is returned the body will be a JSON-serialized object.


Get Rating Box Information

Before using RatingBox information you need to create a RatingBox and assign all properties. The RatingBox ID will be provided at creation time, and is used to reference your RatingBox in all other API calls.

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/GetRatingBox
Post your Company and RatingBox identifiers and retrieves the metadata of your RatingBox in this account. The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "CompanyGuid": identification of the account/company being accessed
    This client ID is required in most cases
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "UserId": your customer identifier
    If you do not allow anonymous rating and review
200 OK - Get RatingBox meta data
The response body will contain a JSON object(RatingBoxDto).
Each property encapsulates specific functionality or behavior on a page.
404 No RatingBox existed for the identifiers
The response body will be empty.

Submit Ratings and Reviews

Ratings and Review can be added, updated. An identifier must be provided for your account.

Every field defined in the JSON object will be updated.

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/SubmitRatingBox
Post your Company and RatingBox identifiers and retrieves the metadata of your RatingBox in this account. The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "CompanyGuid": identification of the account/company being accessed
    This client ID is required in most cases
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "UserId": your customer identifier
    If you do not allow anonymous rating and review
200 OK - Ratings and review were submitted
The response body will contain a JSON object(RatingBoxDto).
Each property encapsulates specific functionality or behavior on a page.
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Get Reviews

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/GetReviews
The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "SearchText": text you are searching for (default: "")
  • "SortExpression": sorting order of reviews to return (default: "AppliedOn desc" or "")
  • "PageIndex": for paging, the first position to return
  • "MaxpageDisplay": how many results to return (default: 10)
200 OK - Get a list of Rating and Reviews
The response body will contain a JSON object(ProductReviewsDto).
Each property encapsulates specific value, functionality or behavior on a page.
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Get Tags

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/GetTags
Post your Company and RatingBox identifiers and retrieves the metadata of your RatingBox in this account. The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "CompanyGuid": identification of the account/company being accessed
    This client ID is required in most cases
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "UserId": your customer identifier
    If you do not allow anonymous rating and review
200 OK - Get a list of tags
The response body will contain a JSON object(ProductTagsDto).
Each property encapsulates specific functionality or behavior on a page.
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Get Questions

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/GetQuestions
Post your Company and RatingBox identifiers and retrieves the metadata of your RatingBox in this account. The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "CompanyGuid": identification of the account/company being accessed
    This client ID is required in most cases
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "UserId": your customer identifier
    If you do not allow anonymous rating and review
200 OK - Get a list of questions
The response body will contain a JSON object(ProductQuestionsDto).
Each property encapsulates specific functionality or behavior on a page.
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Submit Question

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/SubmitQuestion
Post your Company and RatingBox identifiers and retrieves the metadata of your RatingBox in this account. The request body should contain a JSON object(RatingBoxDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
  • "CompanyGuid": identification of the account/company being accessed
    This client ID is required in most cases
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
And optionally:
  • "ProductCode": your product identifier
    A non-empty string no longer than 256 characters
  • "UserId": your customer identifier
    If you do not allow anonymous rating and review
200 OK - Question was submitted
The response body will contain a JSON object(RatingSystemMessage).
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Submit Answer

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/SubmitAnswer
The request body should contain a JSON object(AnswerDto) with:
  • "QuestionId": your question identifier
    A non-empty Integer
  • "RatingboxId": your ratingbox identifier
    A non-empty Integer
200 OK - Answer was submitted
The response body will contain a JSON object(RatingSystemMessage).
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.

Add Company Order

HTTP Request / Description HTTP Response codes / body
POST /<webservice>/AddCompanyOrder
The request body should contain a JSON object(CompanyOrderDto) with:
  • "CompanyId": your account/company identifier
    A non-empty Integer
200 OK - Company order was added
The response body will contain a JSON object(RatingSystemMessage).
400 Invalid or missing argument
A descriptive error message will be found in the body.
500 Service Unavailable
A descriptive error message will be found in the body.