| Required role: | superadmin |
| GET | /superadmin/company/{CompanyId}/comments | Get companies comments. |
|---|
"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 BaseModel {
constructor(init) { Object.assign(this, init) }
}
/** @typedef {number} */
export var CommentsType;
(function (CommentsType) {
CommentsType[CommentsType["NormalComment"] = 1] = "NormalComment"
CommentsType[CommentsType["CallBackPhoneComment"] = 2] = "CallBackPhoneComment"
CommentsType[CommentsType["CallBackEmailComment"] = 3] = "CallBackEmailComment"
CommentsType[CommentsType["CallBackMeetingBookedComment"] = 4] = "CallBackMeetingBookedComment"
CommentsType[CommentsType["CallBackNotInterestedComment"] = 5] = "CallBackNotInterestedComment"
})(CommentsType || (CommentsType = {}));
export class CommentsTypeResponse {
/** @param {{Id?:number,Name?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Description;
}
export class CompanyCommentsResponse {
/** @param {{CompanyId?:string,Id?:number,Comment?:string,CommentTypeId?:CommentsType,CommentType?:CommentsTypeResponse,Updated?:string,Created?:string,CreatedBy?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
CompanyId;
/** @type {number} */
Id;
/** @type {string} */
Comment;
/** @type {CommentsType} */
CommentTypeId;
/** @type {CommentsTypeResponse} */
CommentType;
/**
* @type {string}
* @description The updated date */
Updated;
/**
* @type {string}
* @description The created date */
Created;
/**
* @type {string}
* @description The created by */
CreatedBy;
}
export class CompanyComment extends BaseModel {
/** @param {{CommentsType?:CommentsType,CompanyId?:string,Id?:number,CommentsTypeId?:number,Comments?:string,CreatedBy?:string,Created?:string,Updated?:string,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {CommentsType} */
CommentsType;
/** @type {string} */
CompanyId;
/** @type {number} */
Id;
/** @type {number} */
CommentsTypeId;
/** @type {string} */
Comments;
/** @type {string} */
CreatedBy;
/** @type {string} */
Created;
/** @type {string} */
Updated;
/** @type {?string} */
ModifiedDate;
}
export class CommentsSuperAdminUserQuery extends QueryDb {
/** @param {{CompanyId?:string,CommentsTypeId?:number,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}
* @description Enter the companyId for the customer */
CompanyId;
/** @type {?number} */
CommentsTypeId;
}
export class CommentsType extends BaseModel {
/** @param {{Id?:number,Name?:string,Description?:string,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {?string} */
ModifiedDate;
}
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;
}
JavaScript CommentsSuperAdminUserQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/company/{CompanyId}/comments HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Id: 0,
Comment: String,
CommentTypeId: NormalComment,
CommentType:
{
Id: 0,
Name: String,
Description: String
},
CreatedBy: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}