Overnight Stay
| Request |
|
| Description |
Create or remove an overnight stay for the specified resource. |
| Context |
https://<instance>.optimizemyday.com/omdservices/rest/v1/services/trip |
| URL |
/overnightStay |
| Method |
POST or DELETE |
| Response Code |
200 when successful, another HTTP status code otherwise |
| Success Response |
|
| Response Type |
XML or JSON |
| Parameter |
Datatype |
Description |
| configId |
Integer |
The identifier of the configuration. |
| resourceId |
String |
The external identifier of the resource. |
| date |
Date |
The day for which the overnight stay is created or removed. |
| arrival |
Time |
The time of arrival at the location. The default time is "17:00:00", if omitted. |
| nights |
Integer |
The number of nights requested. |
| departure |
Time |
The time of departure from the location. The default time is "08:00:00", if omitted. |
| street |
String |
The street and house number of the address. Required for POST only. |
| postalCode |
String |
The postal code of the address. Required for POST only. |
| province |
String |
The province or state of the address. Required for POST only. |
| city |
String |
The city of the address. Required for POST only. |
| country |
String |
The country of the address. Required for POST only. |
| persist |
String |
Indicates if the changes must be persisted to the database. |
| _output |
String |
The requested output format being xml or json. If omitted, xml is assumed. |
Sample Call
https://sandbox.optimizemyday.com/omdservices/rest/v1/services/trip/overnightStay?configId=16167225&resourceId=10000024&date=2017-09-25&nights=2&street=Grafenberger%20Allee%20100&postalCode=40237&province=NRW&&city=D%C3%BCsseldorf&country=DE
Sample Result
<Result success="true">
<OvernightStay configuration="16167225" resource="10000024" date="2017-09-25 00:00:00" nights="2" street="Grafenberger Allee 100" city="Düsseldorf" postalCode="40237" province="NRW" country="DE"/>
</Result>