Ratings

Search for ratings

post/api/Ratings/Search

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Ratings/Search
  • Auth: API key in header Authorization

Request body

typestring nullable

The object class to get ratings from (e.g. BusinessCustomer, Product, etc)

objectIdstring nullable

The object id to get ratings from (e.g. 12345)

parentObjectIdstring nullable

Parent ID For product ratings this will be product.ParentId. Search for ratings where products share the same parentId

marketIdsstring[] nullable

List of marketids to filter on

storeIdsstring[] nullable

List of storeIds to filter on

pageinteger

Page number, fallback to 1

takeinteger

Number of elements, fallback to 10

requiresAttentionboolean nullable

Filter on ratings that requires attention by customer service (no value -> all)

includeOnlyRatingsWithCommentsboolean nullable

If true filter on ratings with comments.

Response

Success

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.