GET | /homepage/menu | Find news items for a company |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | Enter the company you want to see news for, if blank and you are an admin, your company id will be used |
SitePath | query | string | No | The homeage sitepath. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | query | int | No | Skip 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 |
Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
OrderBy | query | string | No | 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. Example: ?orderBy=Id,-Age,FirstName |
OrderByDesc | query | string | No | 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. Example: ?orderByDesc=Id,-Age,FirstName |
Include | query | string | No | Include 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 |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HomeText | form | string | Yes | |
HomeHidden | form | bool | Yes | |
ServicesText | form | string | Yes | |
ServicesHidden | form | bool | Yes | |
BookTimeText | form | string | Yes | |
BookTimeHidden | form | bool | Yes | |
AboutUsText | form | string | Yes | |
AboutUsHidden | form | bool | Yes | |
ContactUsText | form | string | Yes | |
ContactUsHidden | form | bool | Yes | |
MyBookingsText | form | string | Yes | |
MyBookingsHidden | form | bool | Yes | |
CalendarText | form | string | Yes | |
CalendarHidden | form | bool | Yes | |
NewsText | form | string | Yes | |
NewsHidden | form | bool | Yes | |
AddressText | form | string | Yes | |
AddressHidden | form | bool | Yes | |
GalleryText | form | string | Yes | |
GalleryHidden | form | bool | Yes | |
ModifiedDate | form | DateTimeOffset? | No | |
Id | form | Guid | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id |
HomeText | form | string | No | The text for home menu item |
HomeHidden | form | bool | No | If the home menu item should be hidden |
ServicesText | form | string | No | The text for services menu item |
ServicesHidden | form | bool | No | If the services menu item should be hidden |
BookTimeText | form | string | No | The text for book time menu item |
BookTimeHidden | form | bool | No | If the book time menu item should be hidden |
AboutUsText | form | string | No | The text for about us menu item |
AboutUsHidden | form | bool | No | If the about us menu item should be hidden |
ContactUsText | form | string | No | The text for contact us menu item |
ContactUsHidden | form | bool | No | If the contact us menu item should be hidden |
MyBookingsText | form | string | No | The text for my bookings menu item |
MyBookingsHidden | form | bool | No | If the my bookings menu item should be hidden |
CalendarText | form | string | No | The text for calender menu item |
CalendarHidden | form | bool | No | If the calendar menu item should be hidden |
NewsText | form | string | No | The text for news menu item |
NewsHidden | form | bool | No | If the news menu item should be hidden |
AddressText | form | string | No | The text for address menu item |
AddressHidden | form | bool? | No | If the address menu item should be hidden |
GalleryText | form | string | No | The text for gallery menu item |
GalleryHidden | form | bool? | No | If the gallery menu item should be hidden |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<AccessKeyTypeResponse> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
KeyType | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK Content-Type: application/json 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"}}}