Ratings

Get ratings for an Omnium object

get/api/Ratings/GetRatings

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/GetRatings
  • Auth: API key in header Authorization

Query parameters

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)

pageinteger

Page number

takeinteger

Number of elements

ignoreRequiresAttentionboolean

Ignore ratings that needs attention by customer service (default: true)

parentObjectIdstring nullable

The parent object id to get ratings for. If both objectId and parentObjectd has value, "or" query will be used

includeOnlyRatingsWithCommentsboolean

Return only ratings with comments

Request body

string[] nullable required

Filter ratings by markets

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.