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.

export class HomepageImageQueryResponse
{
    /** @description The company id. */
    // @ApiMember(Description="The company id.")
    public CompanyId: string;

    /** @description The homepage image id. */
    // @ApiMember(Description="The homepage image id.")
    public Id: number;

    /** @description The image title. */
    // @ApiMember(Description="The image title.")
    public Title: string;

    /** @description The image description. */
    // @ApiMember(Description="The image description.")
    public Description: string;

    /** @description The image url. */
    // @ApiMember(Description="The image url.")
    public ImageUrl: string;

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

// @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 CreateHomepageImage implements ICompany
{
    /** @description 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 CompanyId: string;

    /** @description The image title. */
    // @ApiMember(Description="The image title.")
    public Title: string;

    /** @description The image description. */
    // @ApiMember(Description="The image description.")
    public Description: string;

    /** @description The image url. */
    // @ApiMember(Description="The image url.")
    public ImageUrl: string;

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

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