BokaMera.API.Host

<back to all web services

MessageLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/messages/logSearch the message log for any messagesSearch the message log 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 MessageLogQueryResponse {
    /** @param {{Id?:number,BookingId?:number,Receiver?:string,MessageTitle?:string,StorageUrl?:string,MessageBody?:string,Created?:string,ToSendDate?:string,SentDate?:string,Sent?:boolean,MessageRetries?:number,SendMethodId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The message log id */
    Id;
    /**
     * @type {?number}
     * @description The booking id for the message (if connected to a booking). */
    BookingId;
    /**
     * @type {string}
     * @description The message receiver. Either a email or a mobile phone number. */
    Receiver;
    /**
     * @type {string}
     * @description Message Title. */
    MessageTitle;
    /**
     * @type {string}
     * @description Message Storage Url. */
    StorageUrl;
    /**
     * @type {string}
     * @description Message Body. */
    MessageBody;
    /**
     * @type {string}
     * @description When message was created. */
    Created;
    /**
     * @type {string}
     * @description When the message will be sent. */
    ToSendDate;
    /**
     * @type {?string}
     * @description When the message was sent. */
    SentDate;
    /**
     * @type {boolean}
     * @description If Message is sent */
    Sent;
    /**
     * @type {number}
     * @description Number of retries to send the message */
    MessageRetries;
    /**
     * @type {number}
     * @description Send Method. 1 = Email, 2 = SMS */
    SendMethodId;
}
export class BaseModel {
    constructor(init) { Object.assign(this, init) }
}
export class MessageLog extends BaseModel {
    /** @param {{BookingId?:number,PublicMessage?:boolean,MessageType?:number,iCalAttachment?:boolean,SenderName?:string,ModifiedDate?:string,CorrelationId?:string,CompanyId?:string,Id?:number,Receiver?:string,Sender?:string,MessageTitle?:string,MessageBody?:string,CreatedBy?:string,Created?:string,Sent?:boolean,ToSendDate?:string,SentDate?:string,SendMethodId?:number,MessageCount?:number,SMSStatus?:number,MessageRetries?:number,StorageUrl?:string,Language?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    BookingId;
    /** @type {boolean} */
    PublicMessage;
    /** @type {number} */
    MessageType;
    /** @type {boolean} */
    iCalAttachment;
    /** @type {string} */
    SenderName;
    /** @type {?string} */
    ModifiedDate;
    /** @type {?string} */
    CorrelationId;
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {string} */
    Receiver;
    /** @type {string} */
    Sender;
    /** @type {string} */
    MessageTitle;
    /** @type {string} */
    MessageBody;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    Created;
    /** @type {boolean} */
    Sent;
    /** @type {string} */
    ToSendDate;
    /** @type {?string} */
    SentDate;
    /** @type {number} */
    SendMethodId;
    /** @type {?number} */
    MessageCount;
    /** @type {?number} */
    SMSStatus;
    /** @type {number} */
    MessageRetries;
    /** @type {string} */
    StorageUrl;
    /** @type {string} */
    Language;
}
export class MessageLogQuery extends QueryDb {
    /** @param {{CompanyId?:string,Sent?:boolean,Id?:number,BookingId?:number,Receiver?:string,Created?:string,SentDate?:string,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 search on sent messages */
    Sent;
    /**
     * @type {?number}
     * @description Message Id */
    Id;
    /**
     * @type {?number}
     * @description If you want to search on a messages for a specific booking */
    BookingId;
    /**
     * @type {string}
     * @description If you want to search on a messages for a specific receiver */
    Receiver;
    /**
     * @type {?string}
     * @description If you want to search on a messages created a specific date */
    Created;
    /**
     * @type {?string}
     * @description If you want to search on a messages sent a specific date */
    SentDate;
    /** @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 MessageLogQuery DTOs

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

HTTP + JSV

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

GET /messages/log 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,
			BookingId: 0,
			Receiver: String,
			MessageTitle: String,
			StorageUrl: String,
			MessageBody: String,
			SentDate: "0001-01-01T00:00:00",
			Sent: False,
			MessageRetries: 0,
			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
		}
	}
}