BokaMera.API.Host

<back to all web services

CreateHomepageImage

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/homepage/imagesAdd a new homepage imageAdd a new homepage image to the company of the currently logged in user, only administrators are allowed to add support cases.
using System;
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
{
    [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 CreateHomepageImage
        : 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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The image title.
        ///</summary>
        [ApiMember(Description="The image title.")]
        public virtual string Title { get; set; }

        ///<summary>
        ///The image description.
        ///</summary>
        [ApiMember(Description="The image description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The image url.
        ///</summary>
        [ApiMember(Description="The image url.")]
        public virtual Uri ImageUrl { get; set; }
    }

    public partial class HomepageImageQueryResponse
    {
        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The homepage image id.
        ///</summary>
        [ApiMember(Description="The homepage image id.")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The image title.
        ///</summary>
        [ApiMember(Description="The image title.")]
        public virtual string Title { get; set; }

        ///<summary>
        ///The image description.
        ///</summary>
        [ApiMember(Description="The image description.")]
        public virtual string Description { get; set; }

        ///<summary>
        ///The image url.
        ///</summary>
        [ApiMember(Description="The image url.")]
        public virtual Uri ImageUrl { get; set; }
    }

}

C# CreateHomepageImage DTOs

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

HTTP + JSV

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

POST /homepage/images HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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