| GET | /homepage/menu | Find news items for a company |
|---|
"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 HomepageMenuQueryResponse {
/** @param {{CompanyId?:string,HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The company id */
CompanyId;
/**
* @type {string}
* @description The text for home menu item */
HomeText;
/**
* @type {boolean}
* @description If the home menu item should be hidden */
HomeHidden;
/**
* @type {string}
* @description The text for services menu item */
ServicesText;
/**
* @type {boolean}
* @description If the services menu item should be hidden */
ServicesHidden;
/**
* @type {string}
* @description The text for book time menu item */
BookTimeText;
/**
* @type {boolean}
* @description If the book time menu item should be hidden */
BookTimeHidden;
/**
* @type {string}
* @description The text for about us menu item */
AboutUsText;
/**
* @type {boolean}
* @description If the about us menu item should be hidden */
AboutUsHidden;
/**
* @type {string}
* @description The text for contact us menu item */
ContactUsText;
/**
* @type {boolean}
* @description If the contact us menu item should be hidden */
ContactUsHidden;
/**
* @type {string}
* @description The text for my bookings menu item */
MyBookingsText;
/**
* @type {boolean}
* @description If the my bookings menu item should be hidden */
MyBookingsHidden;
/**
* @type {string}
* @description The text for calender menu item */
CalendarText;
/**
* @type {boolean}
* @description If the calendar menu item should be hidden */
CalendarHidden;
/**
* @type {string}
* @description The text for news menu item */
NewsText;
/**
* @type {boolean}
* @description If the news menu item should be hidden */
NewsHidden;
/**
* @type {string}
* @description The text for address menu item */
AddressText;
/**
* @type {?boolean}
* @description If the address menu item should be hidden */
AddressHidden;
/**
* @type {string}
* @description The text for gallery menu item */
GalleryText;
/**
* @type {?boolean}
* @description If the gallery menu item should be hidden */
GalleryHidden;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class HomepageMenu extends BaseModel {
/** @param {{HomeText?:string,HomeHidden?:boolean,ServicesText?:string,ServicesHidden?:boolean,BookTimeText?:string,BookTimeHidden?:boolean,AboutUsText?:string,AboutUsHidden?:boolean,ContactUsText?:string,ContactUsHidden?:boolean,MyBookingsText?:string,MyBookingsHidden?:boolean,CalendarText?:string,CalendarHidden?:boolean,NewsText?:string,NewsHidden?:boolean,AddressText?:string,AddressHidden?:boolean,GalleryText?:string,GalleryHidden?:boolean,ModifiedDate?:string,Id?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
HomeText;
/** @type {boolean} */
HomeHidden;
/** @type {string} */
ServicesText;
/** @type {boolean} */
ServicesHidden;
/** @type {string} */
BookTimeText;
/** @type {boolean} */
BookTimeHidden;
/** @type {string} */
AboutUsText;
/** @type {boolean} */
AboutUsHidden;
/** @type {string} */
ContactUsText;
/** @type {boolean} */
ContactUsHidden;
/** @type {string} */
MyBookingsText;
/** @type {boolean} */
MyBookingsHidden;
/** @type {string} */
CalendarText;
/** @type {boolean} */
CalendarHidden;
/** @type {string} */
NewsText;
/** @type {boolean} */
NewsHidden;
/** @type {string} */
AddressText;
/** @type {boolean} */
AddressHidden;
/** @type {string} */
GalleryText;
/** @type {boolean} */
GalleryHidden;
/** @type {?string} */
ModifiedDate;
/** @type {string} */
Id;
}
export class HomepageMenuQuery extends QueryDb {
/** @param {{CompanyId?:string,SitePath?: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}
* @description Enter the company you want to see news for, if blank and you are an admin, your company id will be used */
CompanyId;
/**
* @type {string}
* @description The homeage sitepath. */
SitePath;
}
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 HomepageMenuQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /homepage/menu HTTP/1.1 Host: api.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"HomeText":"String","HomeHidden":false,"ServicesText":"String","ServicesHidden":false,"BookTimeText":"String","BookTimeHidden":false,"AboutUsText":"String","AboutUsHidden":false,"ContactUsText":"String","ContactUsHidden":false,"MyBookingsText":"String","MyBookingsHidden":false,"CalendarText":"String","CalendarHidden":false,"NewsText":"String","NewsHidden":false,"AddressText":"String","AddressHidden":false,"GalleryText":"String","GalleryHidden":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}