BokaMera.API.Host

<back to all web services

ReviewQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/rating/reviewsGet ReviewsGet Reviews.
ReviewQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?No
IdqueryGuid?No
Activequerybool?NoIf you want to collect only active reviews
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Review Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformGuidNo
CompanyIdformGuidYes
TitleformstringYes
DescriptionformstringYes
AuthorformstringYes
StatusformintYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
ReviewAnswerformstringNo
RatingReviewResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYesThe title for the review
DescriptionformstringYesThe description for the review
RatingScoreformintNoThe rating score
AuthorformstringYesThe review author
CreatedformDateTimeNoThe created date
ReviewAnswerformstringYesThe review answer from the company
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringYes
DescriptionformstringYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /rating/reviews HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Title":"String","Description":"String","RatingScore":0,"Author":"String","ReviewAnswer":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}