| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /messages/dashboard | Search the dashboard messages for any messages. | Search the dashboard messages for any messages. |
|---|
"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 DasboardMessageTypeResponse {
/** @param {{Id?:number,Name?:string,Description?:string,ImageUrl?:string,ApplicationMessage?:boolean,Icon?:string,Color?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The message type id */
Id;
/**
* @type {string}
* @description The message type name */
Name;
/**
* @type {string}
* @description The message type description */
Description;
/**
* @type {string}
* @description The message type image */
ImageUrl;
/**
* @type {?boolean}
* @description If the message type is a application message */
ApplicationMessage;
/**
* @type {string}
* @description The message type icon */
Icon;
/**
* @type {string}
* @description The message type color */
Color;
}
export class DashboardMessageQueryResponse {
/** @param {{Id?:number,Title?:string,Body?:string,Important?:boolean,VisibleFrom?:string,VisibleTo?:string,Created?:string,MessageTypeId?:number,SupportCaseId?:number,MessageType?:DasboardMessageTypeResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The message id */
Id;
/**
* @type {string}
* @description The message title. */
Title;
/**
* @type {string}
* @description The message body. */
Body;
/**
* @type {boolean}
* @description If the message is important. */
Important;
/**
* @type {string}
* @description If the message visible from date. */
VisibleFrom;
/**
* @type {string}
* @description If the message visible to date. */
VisibleTo;
/**
* @type {string}
* @description If the message created date. */
Created;
/**
* @type {number}
* @description If the message type id. */
MessageTypeId;
/**
* @type {?number}
* @description If the message is connected to a support case. */
SupportCaseId;
/**
* @type {DasboardMessageTypeResponse}
* @description If the message type information. */
MessageType;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class DashboardMessageType extends BaseModel {
/** @param {{Name?:string,Description?:string,Image?:string,ApplicationMessage?:boolean,Color?:string,Icon?:string,ModifiedDate?:string,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Image;
/** @type {?boolean} */
ApplicationMessage;
/** @type {string} */
Color;
/** @type {string} */
Icon;
/** @type {?string} */
ModifiedDate;
/** @type {number} */
Id;
}
export class DashboardMessage extends BaseModel {
/** @param {{MessageTypeId?:number,MessageType?:DashboardMessageType,CompanyId?:string,Id?:number,Title?:string,Body?:string,Important?:boolean,VisibleFrom?:string,VisibleTo?:string,Created?:string,SupportCaseId?:number,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
MessageTypeId;
/** @type {DashboardMessageType} */
MessageType;
/** @type {string} */
CompanyId;
/** @type {number} */
Id;
/** @type {string} */
Title;
/** @type {string} */
Body;
/** @type {boolean} */
Important;
/** @type {string} */
VisibleFrom;
/** @type {string} */
VisibleTo;
/** @type {string} */
Created;
/** @type {?number} */
SupportCaseId;
/** @type {?string} */
ModifiedDate;
}
export class DashboardMessageQuery extends QueryDb {
/** @param {{CompanyId?:string,Important?:boolean,MessageTypeId?:number,IncludeMessageTypeInformation?:boolean,ResponseStatus?:ResponseStatus,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 The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {?boolean}
* @description If you want to filter on important messages only */
Important;
/**
* @type {?number}
* @description Filter on Message Type Id */
MessageTypeId;
/**
* @type {boolean}
* @description If you want to include the message type information */
IncludeMessageTypeInformation;
/** @type {ResponseStatus} */
ResponseStatus;
}
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 DashboardMessageQuery 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 /messages/dashboard 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:
[
{
Id: 0,
Title: String,
Body: String,
Important: False,
MessageTypeId: 0,
SupportCaseId: 0,
MessageType:
{
Id: 0,
Name: String,
Description: String,
ImageUrl: String,
ApplicationMessage: False,
Icon: String,
Color: String
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}