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.
import Foundation
import ServiceStack

// @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 class UpdateHomepageImage : ICompany, Codable
{
    /**
    * Enter the company id, if blank company id and you are an admin, your company id will be used.
    */
    // @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
    public var companyId:String?

    /**
    * The homepage image id.
    */
    // @ApiMember(Description="The homepage image id.", IsRequired=true, ParameterType="path")
    public var id:Int

    /**
    * The image title.
    */
    // @ApiMember(Description="The image title.")
    public var title:String

    /**
    * The image description.
    */
    // @ApiMember(Description="The image description.")
    public var Description:String

    /**
    * The image url.
    */
    // @ApiMember(Description="The image url.")
    public var imageUrl:Uri

    required public init(){}
}

public class HomepageImageQueryResponse : Codable
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.")
    public var companyId:String

    /**
    * The homepage image id.
    */
    // @ApiMember(Description="The homepage image id.")
    public var id:Int

    /**
    * The image title.
    */
    // @ApiMember(Description="The image title.")
    public var title:String

    /**
    * The image description.
    */
    // @ApiMember(Description="The image description.")
    public var Description:String

    /**
    * The image url.
    */
    // @ApiMember(Description="The image url.")
    public var imageUrl:Uri

    required public init(){}
}


Swift UpdateHomepageImage 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.

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

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

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