Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Tag

Format

Example

Description

activities

 

<activities>

Activity-tag encloses activities

startdate

Date

<startdate>2015-12-24</startdate>

Specifies the date that the class first starts

enddate

Date

<enddate>2015-12-24</enddate>

Specifies the date the class last starts after

activity

 

 

A specific scheduled class

id

ID

<id>12</id>

Unique ID

businessunit

 

<businessunit><id>11</id><name>Main Street Gym</name></businessunit>

The business unit/facility the booking belongs to

start

Time

<start><timepoint><timestamp>1337164200</timestamp><datetime>2015-05-16 12:30</datetime><date>2015-05-16</date><time>12:30</time></timepoint></start>

The start time for the booking

end

Time

<end><timepoint><timestamp>1337167800</timestamp><datetime>2015-05-16 13:30</datetime><date>2015-05-16</date><time>13:30</time></timepoint></end>

The end time for the booking

product

 

<product>see products</product>

The product behind the booking. For more details please see products.

resources

 

 

List of resources

resource

String

<resource><id>31</id><name>Marge Simpson</name><type>Staff</type></resource>

Staff, instructor or room used for the class

bookableearliest

Time

<bookableearliest><timepoint><timestamp>1337342800</timestamp><datetime>2015-05-26 23:30</datetime><date>2015-05-26</date><time>23:30</time></timepoint></bookableearliest>

The earliest a customer can book themselves into the class

bookablelatest

Time

<bookablelatest><timepoint><timestamp>1337235000</timestamp><datetime>2015-05-30 12:00</datetime><date>2015-05-30</date><time>12:00</time></timepoint></bookablelatest>

The latest a customer can book themselves into the class

debookablelatestTime<debookablelatest><timepoint><timestamp>1337235000</timestamp><datetime>2015-05-29 12:00</datetime><date>2015-05-30</date><time>12:00</time></timepoint></debookablelatest>The latest a customer can debook themselve from a class. If debookablelatest is equal to start-time (see start), there are no debookingrules.
externalmessageString

<externalmessage></externalmessage>

External message

freeslots

Integer

<freeslots>10</freeslots>

Available places. The class may have dropin slots that are reserved and can only be booked on location. If bookableslots=0 then freeslots can be > 0.

bookableslots

Integer

<bookableslots>10</bookableslots>

Number of bookable places remaining

totalslots

Integer

<totalslots>42</totalslots>

Total number of places

slotsreservedfordropinInteger<slotsreservedfordropin>14</slotsreservedfordropin>Number of places reserved for dropin customers

cancelled

Boolean

<cancelled>false</cancelled>

The class is cancelled

waitinglistsize

Integer

<waitinglistsize>3</waitinglistsize>

The number of people on the waiting list. There is no maximum limit.

waitinglistpositionInteger

<waitinglistposition>2</waitinglistposition>

A specific customer's place in the waiting list.

bookingid

ID

<bookingid>3456</bookingid>

ID of the booking or waiting list space

bookingtype

String

<bookingtype>ordinary</bookingtype>

Type of place

participants <participants><participant><id>22</id><personid>23</personid><firstname>John</firstname><lastname>Doe</lastname></participant></participants>Participants of the class

...