BokaMera.API.Host

<back to all web services

ResourceTypeAvailableResourcesQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/bookings/{Id}/resources/availableFind available resources.
"use strict";
export class AvailableResourceResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,Color?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resource id */
    Id;
    /**
     * @type {string}
     * @description The resource name */
    Name;
    /**
     * @type {string}
     * @description The resource description */
    Description;
    /**
     * @type {string}
     * @description The resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue. */
    Color;
    /**
     * @type {string}
     * @description The image url of the resource */
    ImageUrl;
}
export class ResourceTypeAvailableResourcesQueryResponse {
    /** @param {{Id?:number,Resources?:AvailableResourceResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resourcetype id */
    Id;
    /**
     * @type {AvailableResourceResponse[]}
     * @description The available resources */
    Resources;
}
export class ResourceTypeAvailableResourcesQuery {
    /** @param {{CompanyId?:string,Id?:number,ResourceTypeId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Enter the company and id you want to see the information for a resourcetype, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown  */
    CompanyId;
    /**
     * @type {number}
     * @description Enter the id for the booking. */
    Id;
    /**
     * @type {number}
     * @description Enter the id for a resourcetype. */
    ResourceTypeId;
}

JavaScript ResourceTypeAvailableResourcesQuery 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.

GET /bookings/{Id}/resources/available HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceTypeAvailableResourcesQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Id>0</Id>
  <Resources>
    <AvailableResourceResponse>
      <Color>String</Color>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </AvailableResourceResponse>
  </Resources>
</ResourceTypeAvailableResourcesQueryResponse>