BokaMera.API.Host

<back to all web services

UpdateHomepageImage

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/images/{Id}Update a homepage imageUpdate a homepage image to the company of the currently logged in user, only administrators are allowed to add support cases.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class HomepageImageQueryResponse
            '''<Summary>
            '''The company id.
            '''</Summary>
            <ApiMember(Description:="The company id.")>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''The homepage image id.
            '''</Summary>
            <ApiMember(Description:="The homepage image id.")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The image title.
            '''</Summary>
            <ApiMember(Description:="The image title.")>
            Public Overridable Property Title As String

            '''<Summary>
            '''The image description.
            '''</Summary>
            <ApiMember(Description:="The image description.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The image url.
            '''</Summary>
            <ApiMember(Description:="The image url.")>
            Public Overridable Property ImageUrl As Uri
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class UpdateHomepageImage
            Implements ICompany
            '''<Summary>
            '''Enter the company id, if blank company id and you are an admin, your company id will be used.
            '''</Summary>
            <ApiMember(Description:="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired:=true)>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''The homepage image id.
            '''</Summary>
            <ApiMember(Description:="The homepage image id.", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The image title.
            '''</Summary>
            <ApiMember(Description:="The image title.")>
            Public Overridable Property Title As String

            '''<Summary>
            '''The image description.
            '''</Summary>
            <ApiMember(Description:="The image description.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''The image url.
            '''</Summary>
            <ApiMember(Description:="The image url.")>
            Public Overridable Property ImageUrl As Uri
        End Class
    End Namespace
End Namespace

VB.NET UpdateHomepageImage DTOs

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

HTTP + OTHER

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

PUT /homepage/images/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Title":"String","Description":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"Title":"String","Description":"String"}