BokaMera.API.Host

<back to all web services

CustomFieldSlotsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/customfields/slotsFind all slots to store custom fields data inGet all available slots that are avaialble to store data in
"use strict";
export class CustomFieldSlotsQueryResponse {
    /** @param {{Table?:string,Id?:number,Name?:string,Datatype?:string,Occupied?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Table to which the field belongs */
    Table;
    /**
     * @type {number}
     * @description Custom field id */
    Id;
    /**
     * @type {string}
     * @description Custom field column name */
    Name;
    /**
     * @type {string}
     * @description The field datatype */
    Datatype;
    /**
     * @type {boolean}
     * @description If the slot is free or occupied */
    Occupied;
}
export class CustomFieldSlotsQuery {
    /** @param {{CompanyId?:string,Table?:string,FreeSlots?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Company id to find custom fields for */
    CompanyId;
    /**
     * @type {string}
     * @description Table to which the field belongs */
    Table;
    /**
     * @type {?boolean}
     * @description If you want to receive only free slots (not occupied). */
    FreeSlots;
}

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

GET /customfields/slots HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Table: String,
	Id: 0,
	Name: String,
	Datatype: String,
	Occupied: False
}