BokaMera.API.Host

<back to all web services

UpdateHomepageMenu

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/menuUpdate the homepage menuUpdate the homepage menu on the company of the currently logged in user, only administrators are allowed to update homepage menu.
UpdateHomepageMenu Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
HomeTextbodystringNoThe text for home menu item
HomeHiddenbodybool?NoIf the home menu item should be hidden
ServicesTextbodystringNoThe text for services menu item
ServicesHiddenbodybool?NoIf the services menu item should be hidden
BookTimeTextbodystringNoThe text for book time menu item
BookTimeHiddenbodybool?NoIf the book time menu item should be hidden
AboutUsTextbodystringNoThe text for about us menu item
AboutUsHiddenbodybool?NoIf the about us menu item should be hidden
ContactUsTextbodystringNoThe text for contact us menu item
ContactUsHiddenbodybool?NoIf the contact us menu item should be hidden
MyBookingsTextbodystringNoThe text for my bookings menu item
MyBookingsHiddenbodybool?NoIf the my bookings menu item should be hidden
CalendarTextbodystringNoThe text for calendar menu item
CalendarHiddenbodybool?NoIf the calendar menu item should be hidden
NewsTextbodystringNoThe text for news menu item
NewsHiddenbodybool?NoIf the news menu item should be hidden
AddressTextbodystringNoThe text for address menu item
AddressHiddenbodybool?NoIf the address menu item should be hidden
GalleryTextbodystringNoThe text for gallery menu item
GalleryHiddenbodybool?NoIf the gallery menu item should be hidden
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

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

HTTP + JSON

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

PUT /homepage/menu HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","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}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}}}