| GET | /messages/templates/types | Get message types | Get all message types used by the message templates. |
|---|
"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} */
Skip;
/** @type {?number} */
Take;
/** @type {?string} */
OrderBy;
/** @type {?string} */
OrderByDesc;
/** @type {?string} */
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 MessageTypeQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string,MaxCharacters?:number,DefaultText?:string,SendMethodId?:number}} [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 {number}
* @description The maximum number of characters that can be entered into message body using this type. */
MaxCharacters;
/**
* @type {string}
* @description The default text that is always included when sending messages of this type. */
DefaultText;
/**
* @type {number}
* @description The send method for this type. 1 = Email, 2 = SMS. */
SendMethodId;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class MessageType extends BaseModel {
/** @param {{Name?:string,Description?:string,MaxCharacters?:number,DefaultText?:string,SendMethodId?:number,ModifiedDate?:string,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {number} */
MaxCharacters;
/** @type {string} */
DefaultText;
/** @type {number} */
SendMethodId;
/** @type {?string} */
ModifiedDate;
/** @type {number} */
Id;
}
export class MessageTypeQuery extends QueryDb {
/** @param {{Id?:number,SendMethodId?: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 {?number}
* @description The message type id. */
Id;
/**
* @type {?number}
* @description The message send method id. 1 = Email, 2 = SMS */
SendMethodId;
}
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 MessageTypeQuery 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/templates/types 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,
Name: String,
Description: String,
MaxCharacters: 0,
DefaultText: String,
SendMethodId: 0
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}