BokaMera.API.Host

<back to all web services

HomepageMenuQuery

The following routes are available for this service:
GET/homepage/menuFind news items for a company
HomepageMenuQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company you want to see news for, if blank and you are an admin, your company id will be used
SitePathquerystringNoThe homeage sitepath.
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma 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.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
HomepageMenu Parameters:
NameParameterData TypeRequiredDescription
HomeTextformstringYes
HomeHiddenformboolYes
ServicesTextformstringYes
ServicesHiddenformboolYes
BookTimeTextformstringYes
BookTimeHiddenformboolYes
AboutUsTextformstringYes
AboutUsHiddenformboolYes
ContactUsTextformstringYes
ContactUsHiddenformboolYes
MyBookingsTextformstringYes
MyBookingsHiddenformboolYes
CalendarTextformstringYes
CalendarHiddenformboolYes
NewsTextformstringYes
NewsHiddenformboolYes
AddressTextformstringYes
AddressHiddenformboolYes
GalleryTextformstringYes
GalleryHiddenformboolYes
ModifiedDateformDateTimeOffset?No
IdformGuidYes
HomepageMenuQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
HomeTextformstringNoThe text for home menu item
HomeHiddenformboolNoIf the home menu item should be hidden
ServicesTextformstringNoThe text for services menu item
ServicesHiddenformboolNoIf the services menu item should be hidden
BookTimeTextformstringNoThe text for book time menu item
BookTimeHiddenformboolNoIf the book time menu item should be hidden
AboutUsTextformstringNoThe text for about us menu item
AboutUsHiddenformboolNoIf the about us menu item should be hidden
ContactUsTextformstringNoThe text for contact us menu item
ContactUsHiddenformboolNoIf the contact us menu item should be hidden
MyBookingsTextformstringNoThe text for my bookings menu item
MyBookingsHiddenformboolNoIf the my bookings menu item should be hidden
CalendarTextformstringNoThe text for calender menu item
CalendarHiddenformboolNoIf the calendar menu item should be hidden
NewsTextformstringNoThe text for news menu item
NewsHiddenformboolNoIf the news menu item should be hidden
AddressTextformstringNoThe text for address menu item
AddressHiddenformbool?NoIf the address menu item should be hidden
GalleryTextformstringNoThe text for gallery menu item
GalleryHiddenformbool?NoIf the gallery menu item should be hidden
ResponseStatusformResponseStatusNo
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}