Page tree
Skip to end of metadata
Go to start of metadata

List resources

Lists resources such as rooms, staff, equipment etc.

Request

HTTP GET till /resources

Filter

NAme

Required

Example

Description

Data type

Default

businessunitids

Yes

businessunitid=4,11

Only resources for specified business unit/facility

ID-list

 

productid

No

productid=23

Only resources for specified product

ID

 

type

No

type=Room

Filter by resource type

String

 

label

No

label=Aerobics room 1

Filter by resource label

String

 

includeemployees

No

includeemployees=true

Include staff resources

Boolean

false

Example:

APIURL/resources.xml?apikey=338934897438&businessunitids=4&type=Lokal

Svar

Tag

Exempel

Format

Förklaring

id

<id>11</id>

ID

Unique ID

name

<name>Aerobics room 1</name>

String

Name or resource

type

<type>Room</type>

String

Type

information

<information>Maximum capacity 20 persons</information>

String

Notes, if any

lastupdate

<lastupdate>>2011-12-14 06:54</lastupdate>

Time

When the resource was modified last

isemployee

<isemployee>false</isemployee>

Boolean

If employee resource or not

employee

<employee>

 

The employee connected to the specified resource

id

<id>23</id>

ID

Employee ID

name

<name>John Doe</name>

String

Name of employee

businessunits

<businessunits>

 

Business units (facilities) the specified resource is available at

businessunit

<businessunit><id>2</id><name>BRP Systems</name></businessunit>

 

Business unit (facility)

<resources>
  <resource>
    <id>11</id>
    <name>Aerobics Room 1</name>
    <type>Room</type>
    <information>Maximum capacity 20 persons</information>
    <lastupdate>2011-12-14 06:54</lastupdate>
    <isemployee>false</isemployee>
    <employee/>
    <businessunits>
      <businessunit>
        <id>2</id>
        <name>BRP Systems</name>
      </businessunit>
    </businessunits>
  </resource>
  <resource>
    <id>29</id>
    <name>Johannes</name>
    <type>Employee</type>
    <information/>
    <isemployee>true</isemployee>
    <employee>
      <id>23</id>
      <name>John Doe</name>
    </employee>
    <businessunits>
      <businessunit>
        <id>2</id>
        <name>BRP Systems</name>
      </businessunit>
    </businessunits>
  </resource>
  <resource>
  ...
  </resource>
</resource>
  • No labels