Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetOutOfOfficeInfoForUser

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetOutOfOfficeInfoForUser

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetOutOfOfficeInfoForUser

Gets out-of-office information for the given or connected user.

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetOutOfOfficeInfoForUser

Element Name	Element Type	Restrictions	Description
■ parameters
■ GetAsDelegateInfoList	xs:boolean		Sets to 'true' to get out-of-office info where the user is a delegate.
□ User		nillable	Sets the user to get out-of-office details. If not set or set to null, the information will be retrieved for the connected user.
□ DomainName	xs:string	nillable	Sets domain name of the user or user group.
□ UserId	xs:int	nillable	Sets ID of a Therefore™ user. Only Therefore™ users have a unique user ID assigned. For all the other users set UserName, DomainName.
□ UserName	xs:string	nillable	Sets user name of the user or user group.
□ UserType		nillable restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Sets type of the user or user group.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetOutOfOfficeInfoForUserResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ UserOutOfOfficeInfo		nillable	Gets out-of-office details for the user.
■ IsOutOfOfficeEnabled	xs:boolean		Gets out of office status.
□ User		nillable	Gets user info.
□ DisplayName	xs:string	nillable	Gets display name of the user or user group.
□ UserId	xs:int	nillable	Gets ID of a Therefore™ user. Only Therefore™ users have a unique user ID assigned. For all other users the default value 0 will be returned.
□ UserName	xs:string	nillable	Gets user name of the user or user group.
□ DomainName	xs:string	nillable	Gets domain name of the user or user group.
■ UserType		restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets type of the user or user group.
□ Description	xs:string	nillable	Gets description of the user or user group.
□ Email	xs:string	nillable	Gets SMTP email address of the user or user group.
□ GUID	xs:string	nillable	Gets the GUID of the user.
■ IsDisabled	xs:boolean		Gets whether the user is disabled or not.
□ DelegateUsers		nillable	Gets list of delegates.
≡ WSOutOfOfficeUserGet		list nillable
□ DisplayName	xs:string	nillable	Gets display name of the user or user group.
□ UserId	xs:int	nillable	Gets ID of a Therefore™ user. Only Therefore™ users have a unique user ID assigned. For all other users the default value 0 will be returned.
□ UserName	xs:string	nillable	Gets user name of the user or user group.
□ DomainName	xs:string	nillable	Gets domain name of the user or user group.
■ UserType		restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets type of the user or user group.
□ Description	xs:string	nillable	Gets description of the user or user group.
□ Email	xs:string	nillable	Gets SMTP email address of the user or user group.
□ GUID	xs:string	nillable	Gets the GUID of the user.
■ IsDisabled	xs:boolean		Gets whether the user is disabled or not.
□ AsDelegateInfoList		nillable	Gets out-of-office info list where the user is a delegate.
≡ WSOutOfOfficeInfo		list nillable
■ IsOutOfOfficeEnabled	xs:boolean		Gets out of office status.
□ User		nillable	Gets user info.
□ DisplayName	xs:string	nillable	Gets display name of the user or user group.
□ UserId	xs:int	nillable	Gets ID of a Therefore™ user. Only Therefore™ users have a unique user ID assigned. For all other users the default value 0 will be returned.
□ UserName	xs:string	nillable	Gets user name of the user or user group.
□ DomainName	xs:string	nillable	Gets domain name of the user or user group.
■ UserType		restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets type of the user or user group.
□ Description	xs:string	nillable	Gets description of the user or user group.
□ Email	xs:string	nillable	Gets SMTP email address of the user or user group.
□ GUID	xs:string	nillable	Gets the GUID of the user.
■ IsDisabled	xs:boolean		Gets whether the user is disabled or not.
□ DelegateUsers		nillable	Gets list of delegates.
≡ WSOutOfOfficeUserGet		list nillable
□ DisplayName	xs:string	nillable	Gets display name of the user or user group.
□ UserId	xs:int	nillable	Gets ID of a Therefore™ user. Only Therefore™ users have a unique user ID assigned. For all other users the default value 0 will be returned.
□ UserName	xs:string	nillable	Gets user name of the user or user group.
□ DomainName	xs:string	nillable	Gets domain name of the user or user group.
■ UserType		restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets type of the user or user group.
□ Description	xs:string	nillable	Gets description of the user or user group.
□ Email	xs:string	nillable	Gets SMTP email address of the user or user group.
□ GUID	xs:string	nillable	Gets the GUID of the user.
■ IsDisabled	xs:boolean		Gets whether the user is disabled or not.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.