BokaMera.API.Host

<back to all web services

ReorderHomepageImages

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/homepage/images/orderReorder homepage imagesSet the display order of homepage images for the current company. The position of each id in the list becomes its SortOrder (0-based).
Imports System
Imports System.IO
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 AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        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 ReorderHomepageImages
            Implements ICompany
            '''<Summary>
            '''Enter the company id, if blank and you are an admin, your company id will be used.
            '''</Summary>
            <ApiMember(Description:="Enter the company id, if blank and you are an admin, your company id will be used.", IsRequired:=true)>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''The homepage image ids in the desired display order (position = SortOrder).
            '''</Summary>
            <ApiMember(Description:="The homepage image ids in the desired display order (position = SortOrder).", IsRequired:=true)>
            Public Overridable Property Ids As List(Of Integer) = New List(Of Integer)
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse) = New List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ReorderHomepageImages 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/order HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Ids":[0]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Title":"String","Description":"String","SortOrder":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}