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).
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    [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("IsAuthenticated")]
    public partial class ReorderHomepageImages
        : 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 virtual Guid CompanyId { get; set; }

        ///<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 virtual List<int> Ids { get; set; } = [];
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# 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"}}}