Miscellaneous
getCurrentDateTime
Get the current date and time from the server. See also getOffsetDateTime
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| UseUTC | Boolean | Flag to indicate whether the returned value should be in UTC or server local time |
Returns
| Return | Type | Description |
|---|---|---|
| CurrentDateTime | iCalDateTimeString | Current date and time in iCal format |
Example
Response in local time
<currentdatetime>20200810T141805</currentdatetime>
Response in UTC time
<currentdatetime>20200810T121805Z</currentdatetime>
getOffsetDateTime
Get the current date and time minus the offset used for reservation changes and cancellations. This value can be used as the EndModified parameter in findReservations and findReservationsCancelled with the BeginModified parameter set to the date and time of the previous execution
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| UseUTC | Boolean | Flag to indicate whether the returned value should be in UTC or local time |
Returns
| Return | Type | Description |
|---|---|---|
| CurrentDateTime | iCalDateTimeString | Current date and time, minus the offset, in iCal format |
Example
Response in local time
<offsetdatetime>20200810T141805</offsetdatetime>
Response in UTC time
<offsetdatetime>20200810T121805Z</offsetdatetime>
shouldChangePassword
Indicates whether the authenticated user's password has expired and should be changed
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
Returns
| Return | Type | Description |
|---|---|---|
| Shouldchangepassword | Boolean | Flag indicating whether the authenticated user should change their password with setPassword |
Example
Request
-
setPassword
Change the password for the authenticated user
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Newpassword | String | New password for the authenticated user |
Returns
| Return | Type | Description |
|---|---|---|
| Changeresult | Status[] | Status of the operation, indicating whether the password was successfully changed or an error message describing the error |
Example
Request
<tns:newpassword>qwerty</tns:newpassword>
getFaults
Get available error codes and messages
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
Returns
| Return | Type | Description |
|---|---|---|
| Faults | Fault[] | Available error codes and corresponding error messages |
Example
Request
-
getLimitations
Get limitations for a specific function
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| FunctionName | String | Name of the function to get limitations for |
Returns
| Return | Type | Description |
|---|---|---|
| Limitations | Limitation[] | Array of limitations for the specified function |
Example
Request
<tns:functionname>findReservations</tns:functionname>
getSoapVersion
Get API version info
Parameters
| Parameter | Type | Description |
|---|
Returns
| Return | Type | Description |
|---|---|---|
| VersionInfo | VersionInfo[] | Major and minor version and current timestamp |
Example
Request
-
getServerInfo
Get server information
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
| Keys | String[] | Key to retrieve server info for, as specified by getServerInfoKeys |
Returns
| Return | Type | Description |
|---|---|---|
| Info | ServerInfo | Requested value for the specified key |
Example
Request
<tns:keys>SERVER_NAME</tns:keys>
<tns:keys>SERVER_VERSION</tns:keys>
<tns:keys>WEB_VERSION</tns:keys>
<tns:keys>DATABASE_NAME</tns:keys>
getServerInfoKeys
Get available server information keys
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
Returns
| Return | Type | Description |
|---|---|---|
| Keys | Key[] | Available server info keys to use in getServerInfo |
Example
Request
-
getSupportInfo
Get local support information
Parameters
| Parameter | Type | Description |
|---|---|---|
| Login | LoginObject | Standard login object with username, password, and application key |
Returns
| Return | Type | Description |
|---|---|---|
| SupportInfo | SupportInfo[] | Array of support information containing contact information and a description |
Example
Request
-