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

GetDocumentProperties

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

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

Returns properties of existing Therefore™ document.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ DocNo	xs:int	mandatory	Sets number of the document.
■ VersionNo	xs:int		Sets the version number of the document. Pass 0 to get the latest version.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ DocumentProperties		nillable	Gets properties of the document.
□ CheckedOutBy	xs:string	nillable	Gets the user name of the user who checked out the document if applicable.
■ CheckedOutOn	xs:dateTime		Gets the date and time when the document was checked out if applicable.
□ CreatedBy	xs:string	nillable	Get the user name of the user who created the document.
■ CreatedOn	xs:dateTime		Gets the date and time when the document was created.
■ DocNo	xs:int		Gets the number of the document.
■ DocSize	xs:long		Gets the size of the document in bytes.
□ Extension	xs:string	nillable	Gets extension.
■ FileCount	xs:int		Gets the number of the streams of the document.
■ HasOldVersion	xs:boolean		Returns true if the document has an older version.
■ LastModified	xs:dateTime		Gets the date and time when the document was modified the last time.
□ ModifiedBy	xs:string	nillable	Gets the user name of the last user who modified the document.
■ VersionNo	xs:int		Gets the version number of the document.
□ CheckedOutByDisplayName	xs:string	nillable	Gets the user display name of the user who checked out the document if applicable.
■ CheckedOutByUserNo	xs:int		Gets the user number of the user who checked out the document if applicable.
□ CreatedByDisplayName	xs:string	nillable	Gets the user display name of the user who created the document.
■ CreatedByUserNo	xs:int		Gets the user number of the user who created the document.
□ ModifiedByDisplayName	xs:string	nillable	Gets the user display name of the user who modified the document.
■ ModifiedByUserNo	xs:int		Gets the user number of the user who modified the document.
□ CheckedOutOnISO8601	xs:string	nillable	Gets the date and time when the document was checked out if applicable (in ISO 8601 format, UTC).
□ CreatedOnISO8601	xs:string	nillable	Gets the date and time when the document was created (in ISO 8601 format, UTC).
□ LastModifiedISO8601	xs:string	nillable	Gets the date and time when the document was modified the last time (in ISO 8601 format, UTC).

Legend:

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