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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@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")
open class CreateHomepageImage : ICompany
{
    /**
    * 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)
    var CompanyId:UUID? = null

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

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

    /**
    * The image url.
    */
    @ApiMember(Description="The image url.")
    var ImageUrl:Uri? = null
}

open class HomepageImageQueryResponse
{
    /**
    * The company id.
    */
    @ApiMember(Description="The company id.")
    var CompanyId:UUID? = null

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

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

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

    /**
    * The image url.
    */
    @ApiMember(Description="The image url.")
    var ImageUrl:Uri? = null
}

Kotlin CreateHomepageImage DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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

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