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).
// @ts-nocheck

// @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")
export class ReorderHomepageImages implements ICompany
{
    /** @description Enter the company id, if blank and you are an admin, your company id will be used. */
    // @ApiMember(Description="Enter the company id, if blank and you are an admin, your company id will be used.", IsRequired=true)
    public CompanyId: string;

    /** @description The homepage image ids in the desired display order (position = SortOrder). */
    // @ApiMember(Description="The homepage image ids in the desired display order (position = SortOrder).", IsRequired=true)
    public Ids: number[] = [];

    public constructor(init?: Partial<ReorderHomepageImages>) { (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

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