Resources

Type	Base Path	Trigger Name
REST resource	~{realm}/resources/	resources

This resource holds all bookable resources, like dinner tables, hairdressing chairs, rooms etc. Resources may be from other resources, such as orders and Resource Maps, which is used to group resources into rooms or sections, and to define a visual layout of where the resources are located within that section.

A resource is always bound to a specific location.

Endpoints

Name	Method	Relative Path	Payload	Response	Description
addResource	POST	~{realm}/resources/	Resource	Stored_Resource	Adds a new location to the list.
listResources	GET	~{realm}/resources/	N/A	Stored_Resource[]	Retrieves a list of resources.
getResource	GET	~{realm}/resources/{id}	N/A	Stored_Resource	Retrieves a location.
putResource	PUT	~{realm}/resources/{id}	Resource	Stored_Resource	Replaces a location.
updateResource	PATCH	~{realm}/resources/{id}	Partial_Resource	Stored_Resource	Updates specified location fields.
removeResource	DELETE	~{realm}/resources/{id}	N/A	N/A	Deletes a location.

Permissions

Permission	Description
edit-resources	Client is allowed to add new resources and to modify or delete existing resources.
show-resources	Client is allowed to query the location list and to fetch individual resources.

Entities

Interface Resource

interface Resource {
    'location': number;
    'name': string;
    'id'?: number;
    'created'?: DateTime;
    'updated'?: DateTime;
    'deleted'?: DateTime;
    'updated-by'?: number;
    'updated-from'?: number;
    'tags'?: string[];
    'labels'?: number[];
}

Property	Data Type	Description
name	String	Name of the resource.
location	Int64	At what location the resource is located.
id	Int64?	The resource ID of this entity.
created	DateTime?	Date and time when this entity was first created.
updated	DateTime?	Date and time when this entity was last modified.
deleted	DateTime?	Date and time when this entity was deleted.
updated-by	Int64?	ID of User who last modified this entity.
updated-from	Int64?	ID of Till (trusted device) which last modified this entity.
labels	Int64[]?	A list of Label IDs associated with this entity.