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

GetSharedLinksForDocument

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

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

Gets all shared links for a specific document, created by the user. If you have Admin permission, you will get all shared links for this document.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ DocNo	xs:int	mandatory	The document number for which the existing shared links should be received. If the user has Admin permissions, you will get all shared links, otherwise you only get shared links created by the user.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ SharedLinks		nillable	The shared links.
≡ WSSharedLink		list nillable
□ CreatedAt	xs:string	nillable	The creation time of the shared link, in ISO 8601 format.
■ CreatedBy	xs:int		The user who created the shared link.
□ CreatedByUserDisplay	xs:string	nillable	The display name of the user who created the shared link.
■ DocNo	xs:int		The document number for which the shared link should be created.
□ ExpiresAt	xs:string	nillable	The expiry date of the created shared link. If it is not set or empty, the default expiry date is used. The date is in ISO 8601 (YYYY-MM-DD) format.
□ Filename	xs:string	nillable	The PDF filename that is used, when the document is downloaded. Only used for 'Public' shared links.
□ LinkId	xs:string	nillable	The link id of the shared link.
□ LinkUrl	xs:string	nillable	The weburl of the shared link.
■ PermissionType		restriction enum (xs:string) - None (0) - ReadOnly (1) - Edit (2)	The PermissionType of the shared link. Which permission the shared link should additionally give.
■ ShareType		restriction enum (xs:string) - Organization (0) - SpecificPeople (1) - Public (2)	The ShareType of the shared link. This sets to whom you can share the link.
□ SharedWithUsers		nillable	Sets a list of users the shared link is shared with. Only used when the ShareType 'SpecificPeople' is used.
≡ WSUser		list nillable
□ Description	xs:string	nillable	Gets or sets the description of the user or user group.
□ DisplayName	xs:string	nillable	Gets or sets the display name of the user or user group.
□ DomainName	xs:string	nillable	Gets or sets the domain name of the user or user group.
□ InFolder	xs:string	nillable	Gets or sets the name of the folder the user or user group belongs to.
□ SMTP	xs:string	nillable	Gets or sets the SMTP email address of the user or user group.
□ UserId	xs:int	nillable	Gets or sets the 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 or sets the user name of the user or user group.
□ UserType		nillable restriction enum (xs:string) - SingleUser (1) - UserGroup (2) - SystemUser (3)	Gets or sets the type of the user or user group.
■ Disabled	xs:boolean		Gets or sets whether the user is disabled or not.
□ GUID	xs:string	nillable	Gets or sets the GUID of the user.
■ OneTimePwd	xs:boolean		Gets or sets whether the user has to change his password on his next log in or not.
■ FileFormat		restriction enum (xs:string) - PDF (0) - Original (1)	The file format of the shared link.Which format should the document be provided as. Only applicable on public shared link.
■ IsPasswordProtected	xs:boolean		Is the shared link password protected?

Legend:

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