BokaMera.API.Host

<back to all web services

RemoveResource

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/resourcetypes/{Id}/removeresourceRemove resource(s) from resourcetypeRemove resource(s) from resourcetype for the currently logged in user, only administrators are allowed to remove resources to resourcetypes.
"use strict";
export class ResourceTypeResource {
    /** @param {{Id?:number,Name?:string,Active?:boolean,Description?:string,Email?:string,Phone?:string,Color?:string,ImageUrl?:string,Priority?:number,EmailNotification?:boolean,SMSNotification?:boolean,EmailReminder?:boolean,SMSReminder?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resource id */
    Id;
    /**
     * @type {string}
     * @description The resource name */
    Name;
    /**
     * @type {boolean}
     * @description The resource status */
    Active;
    /**
     * @type {string}
     * @description The resource description */
    Description;
    /**
     * @type {string}
     * @description The resource email */
    Email;
    /**
     * @type {string}
     * @description The resource phone */
    Phone;
    /**
     * @type {string}
     * @description The resource color */
    Color;
    /**
     * @type {string}
     * @description The resource image */
    ImageUrl;
    /**
     * @type {number}
     * @description The priority of the resource */
    Priority;
    /**
     * @type {boolean}
     * @description If the resource want to receive email notifications */
    EmailNotification;
    /**
     * @type {boolean}
     * @description If the resource want to receive sms notifications */
    SMSNotification;
    /**
     * @type {boolean}
     * @description If the resource want to receive email reminders */
    EmailReminder;
    /**
     * @type {boolean}
     * @description If the resource want to receive sms reminders */
    SMSReminder;
}
export class ResourceTypeQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,Resources?:ResourceTypeResource[],Active?:boolean,Created?:string,Updated?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resourcetype id */
    Id;
    /**
     * @type {string}
     * @description The resourcetype name */
    Name;
    /**
     * @type {string}
     * @description The resourcetype description */
    Description;
    /**
     * @type {ResourceTypeResource[]}
     * @description The resources in the resourcetype. Only shows active resources if not admin. */
    Resources;
    /**
     * @type {boolean}
     * @description If resourcetype is active or not */
    Active;
    /**
     * @type {string}
     * @description Then date when the resource was created */
    Created;
    /**
     * @type {string}
     * @description Then date when the resource was updated */
    Updated;
}
export class RemoveResourceTypeResource {
    /** @param {{Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resource id */
    Id;
}
export class RemoveResource {
    /** @param {{CompanyId?:string,Id?:number,Resources?:RemoveResourceTypeResource[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description The ResourceType id */
    Id;
    /**
     * @type {RemoveResourceTypeResource[]}
     * @description The resources to be removed */
    Resources;
}

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

DELETE /resourcetypes/{Id}/removeresource HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	Description: String,
	Resources: 
	[
		{
			Id: 0,
			Name: String,
			Active: False,
			Description: String,
			Email: String,
			Phone: String,
			Color: String,
			Priority: 0,
			EmailNotification: False,
			SMSNotification: False,
			EmailReminder: False,
			SMSReminder: False
		}
	],
	Active: False
}