List scheduledtimes
Retrieves the scheduled time intervals for a selected resource
Request
HTTP GET /scheduledtimes
Parameters
Name | Required | Value | Description | Default values |
|---|---|---|---|---|
| resource | yes | resource=12 | Selected resource | |
startdate | Yes | startdate=2014-01-01 | Start date for interval | |
enddate | No | enddate=2014-01-02 | End date for interval | startdate + 1 day |
| businessunit | No | businessunit=14 | Select open schedules for a certain businessunit. Regular schedules are always global. Spells (arbetspass) may be locked to specific businessunits. | - |
Example:
APIURL/scheduledtimes.xml?resource=12&startdate=2014-01-01&enddate=2014-01-02
Response
Tag | Format | Example | Description |
|---|---|---|---|
scheduledtimes |
| <scheduledtimes> |
|
startdate | Date | <start>2014-01-01</start> | Start date for search interval |
enddate | Date | <end>2014-01-02</end> | End date search interval |
resource |
| <resource><id>12</id><name>Reception</name></resource> | The selected resource |
| scheduledtime | <scheduledtime> | A scheduled block | |
date | Date | <date>2014-01-01</date> | The date of the scheduled block |
start | Time | <start>10:00</start> | The start time of the scheduled block |
end | Time | <end>12:00</end> | The end time of the scheduled block |
<scheduledtimes> <resource> <id>12</id> <name>Reception</name> </resource> <startdate>2014-01-01</enddate> <enddate>2014-01-02</enddate> <blocks> <block> <date>2014-01-01</date> <start>10:00</start> <end>12:00</end> </block> <block> <date>2014-01-01</date> <start>13:00</start> <end>16:00</end> </block> </blocks> </scheduledtimes>