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.
"use strict";
export class HomepageImageQueryResponse {
    /** @param {{CompanyId?:string,Id?:number,Title?:string,Description?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {number}
     * @description The homepage image id. */
    Id;
    /**
     * @type {string}
     * @description The image title. */
    Title;
    /**
     * @type {string}
     * @description The image description. */
    Description;
    /**
     * @type {string}
     * @description The image url. */
    ImageUrl;
}
export class CreateHomepageImage {
    /** @param {{CompanyId?:string,Title?:string,Description?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Enter the company id, if blank company id and you are an admin, your company id will be used. */
    CompanyId;
    /**
     * @type {string}
     * @description The image title. */
    Title;
    /**
     * @type {string}
     * @description The image description. */
    Description;
    /**
     * @type {string}
     * @description The image url. */
    ImageUrl;
}

JavaScript CreateHomepageImage DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateHomepageImage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <ImageUrl i:nil="true" />
  <Title>String</Title>
</CreateHomepageImage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HomepageImageQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Id>0</Id>
  <ImageUrl i:nil="true" />
  <Title>String</Title>
</HomepageImageQueryResponse>