...
Name | Required | Example | Description | Value | Default |
---|---|---|---|---|---|
productid | Yes | productid=23 | Only suggestions for the specified product | Id |
|
resourceids | No | resourceids=3,66 | Only suggestions for these resources | Id-List |
|
resourcetypeid | No | resourcetypeid=2 | Only suggestions for resources of this type. If any of the resources from resourceids is not of this type they won't be returned. | Id |
|
businessunitid | Yes | businessunitid=2 | Only this business unit/faciltiy | Id |
|
startdate | No | startdate=2012-11-31 | Start day. Please note that the interval between the start and end day may be no longer than one week. | DatumDate | IdagToday |
starttime | No | starttime=10:00 | Start time | TidTime | Nu; avrundat till närmast föregående 5 minNow; rounded up to nearest previous 5 minutes |
enddate | No | enddate=2012-12-01 | End day. Please note that the interval between the start and end day may be no longer than one week. | DatumDate | ImorgonTomorrow |
endtime | No | endtime=20:00 | End time | TidTime | 23:59 |
includeprice | No | true | If true the product's price for each suggested time is included. The price can vary due to scheduling and price lists. Please note that the size of the response will increase significantly. | Boolean | false |
pricelistid | No | 1 | Id för den prislista som priset ska hämtas ifrån. Parametern ignoreras om inte includeprice skickas in. | Id |
...
Code Block |
---|
APIURL/timeslotsuggestions.xml?productid=23&businessunitid=2&resourceids=3,66 |
...
Response
Tag | Format | ExempelExample | FörklaringDescription |
---|---|---|---|
timeslotsuggestions |
| <timeslotsuggestions> | timeslotsuggestions-tagen omsluter tidsförslagen.tag encloses the suggested times |
product |
| <product>Vald | produktSelected product |
id | ID | <id>47</id> | Produktens idProduct ID |
name | Sträng | <name>Massage 60 min</name> | Produktens namnName of product |
timeresolution |
| <timeresolution>01:00</timeresolution/> | Produktens upplösning av tidsförslagProducts time resolution for booking |
timeresolutionfromschedulestart | Boolean | <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>Om tidsförslagen ska räknas från början på schemat eller från slutet av tidigare bokning | If the suggested time should be calculated from the beginning of the resource's schedule or from the end of the previous booking. |
start | Tidpunkt | <start>2012-11-19 20:00</start> | Början på valt intervallThe start of the selected interval |
end | Tidpunkt | <end>2012-12-01 21:00</end> | Slutet på valt intervallThe end of the selected interval |
resources |
| <resources> |
|
resource |
| <resource>Omsluter tidsförslagen för en enskild resurs | Encloses the suggested times for a specific resource |
id | ID | <id>3</id> | Resursens idResource ID |
name | Sträng | <name>Rum <name>Room 3</name> | Resursens namn namnNaem of resource |
resourcerequirementid | ID | <resourcerequirementid>508</resourcerequirementid>Produktens resursbehov som uppfylls av resursen | The products resource requirement that is fullfilled by the resource |
times |
| <times>Omsluter tidsförslagen | Encloses the suggested times |
time |
| <time>Representerar ett enskilt tidsförslag | Represents a particular suggested time |
start | Tidpunkt | <start><timepoint><timestamp>1332442800</timestamp><datetime>2012-03-22 20:00</datetime><date>2012-03-22</date><time>20:00</time></timepoint></start> | StarttidStart time |
end | Tidpunkt | <end><timepoint><timestamp>1332442800</timestamp><datetime>2012-03-22 21:00</datetime><date>2012-03-22</date><time>21:00</time></timepoint></end> | Sluttid. Visas endast om produkten har fix längdEnd time. Only displayed if the specified product has a predefined length. |
connectedresource |
| <connectedresource><id>70</id><name>Anders Eriksson</name></connectedresource> | Annan resurs som den föreslagna tiden är låst till. Är tom när koppling saknasOther resources that the suggested time requires. Is null if not applicable. |
priceincvat | <priceincvat>12500</priceincvat> | ||
priceexvat | <priceexvat>10000</priceexvat> |
Code Block |
---|
<timeslotssuggestions> <product> <id>47</id> <name>Massage 60 min</name> <timeresolution>01:00</timeresolution/> <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart> </product> <start>2012-04-17 19:40</start> <end>2012-04-18 07:15</end> <resources> <resource> <id>3</id> <name>Rum<name>Room 3</name> <resourcerequirementid>508</resourcerequirementid> <times> <time> <start> <timepoint> <timestamp>1332442800</timestamp> <datetime>2012-03-22 20:00</datetime> <date>2012-03-22</date> <time>20:00</time> </timepoint> </start> <end> <timepoint> <timestamp>1332442800</timestamp> <datetime>2012-03-22 21:00</datetime> <date>2012-03-22</date> <time>21:00</time> </timepoint> </end> <priceincvat>12500</priceincvat> <priceexvat>10000</priceexvat> <connectedresource> <id>70</id> <name>Anders Eriksson</name> </connectedresource> </time> <time> ... </time> </times> </resource> ... <resource> <id>2</id> <name>Henrik</name> <resourcerequirementid>15</resourcerequirementid> <times> <time> <start> <timepoint> <timestamp>1332442800</timestamp> <datetime>2012-03-22 20:00</datetime> <date>2012-03-22</date> <time>20:00</time> </timepoint> </start> <end> <timepoint> <timestamp>1332442800</timestamp> <datetime>2012-03-22 21:00</datetime> <date>2012-03-22</date> <time>21:00</time> </timepoint> </end> <connectedresource/> </time> <time> ... </time> </times> </resource> </resources> </timeslotssuggestions> |