| GET | /rating/ | Get Ratings | Get Ratings. |
|---|
"use strict";
export class QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
Skip;
/**
* @type {?number}
* @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
Take;
/**
* @type {string}
* @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
OrderBy;
/**
* @type {string}
* @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
OrderByDesc;
/**
* @type {string}
* @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
Include;
/** @type {string} */
Fields;
/** @type {{ [index: string]: string; }} */
Meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class RatingReviewResponse {
/** @param {{Title?:string,Description?:string,RatingScore?:number,Author?:string,Created?:string,ReviewAnswer?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The title for the review */
Title;
/**
* @type {string}
* @description The description for the review */
Description;
/**
* @type {number}
* @description The rating score */
RatingScore;
/**
* @type {string}
* @description The review author */
Author;
/**
* @type {string}
* @description The created date */
Created;
/**
* @type {string}
* @description The review answer from the company */
ReviewAnswer;
}
export class CompanyRatingResponse {
/** @param {{CompanyId?:string,BookingId?:number,Status?:number,RatingScore?:number,Review?:RatingReviewResponse,CreatedDate?:string,UpdatedDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyId;
/**
* @type {number}
* @description Id of the booking */
BookingId;
/**
* @type {number}
* @description The status of the rating, 1 = Active */
Status;
/**
* @type {number}
* @description The rating score */
RatingScore;
/**
* @type {RatingReviewResponse}
* @description The review if any exists to the rating */
Review;
/** @type {string} */
CreatedDate;
/** @type {string} */
UpdatedDate;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class Review extends BaseModel {
/** @param {{ReviewId?:string,CompanyId?:string,Title?:string,Description?:string,Author?:string,Status?:number,Created?:string,Updated?:string,ModifiedDate?:string,ReviewAnswer?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
ReviewId;
/** @type {string} */
CompanyId;
/** @type {string} */
Title;
/** @type {string} */
Description;
/** @type {string} */
Author;
/** @type {number} */
Status;
/** @type {string} */
Created;
/** @type {string} */
Updated;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
ReviewAnswer;
}
export class Rating extends BaseModel {
/** @param {{ReviewId?:string,Review?:Review,CompanyId?:string,BookingId?:number,RatingScore?:number,Status?:number,Created?:string,Updated?:string,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?string} */
ReviewId;
/** @type {Review} */
Review;
/** @type {string} */
CompanyId;
/** @type {number} */
BookingId;
/** @type {number} */
RatingScore;
/** @type {number} */
Status;
/** @type {string} */
Created;
/** @type {string} */
Updated;
/** @type {?string} */
ModifiedDate;
}
export class RatingQuery extends QueryDb {
/** @param {{CompanyId?:string,BookedEventId?:number,Active?:boolean,IncludeRatingReviews?:boolean,CreatedFrom?:string,CreatedTo?:string,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?string} */
CompanyId;
/**
* @type {?number}
* @description Id of the booking */
BookedEventId;
/**
* @type {?boolean}
* @description If you want to collect only active ratings. Ratings are only active after one has past since creation date. */
Active;
/**
* @type {boolean}
* @description If you want to include the rating reviews */
IncludeRatingReviews;
/**
* @type {?string}
* @description Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339 */
CreatedFrom;
/**
* @type {?string}
* @description End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339 */
CreatedTo;
}
export class AccessKeyTypeResponse {
/** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
KeyType;
/** @type {string} */
Description;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Offset;
/** @type {number} */
Total;
/** @type {T[]} */
Results;
/** @type {{ [index: string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /rating/ 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":[{"BookingId":0,"Status":0,"RatingScore":0,"Review":{"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"}}}