Therefore Web API Programming Interface 1.0

ResolveSharedLink

Scroll

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

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

Resolves a shared link.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ LinkId	xs:string	mandatory nillable	The shared link id which should be resolved.
□ Password	xs:string	nillable	The password for the shared link. Can be empty if the shared link does not require a password.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ AuthenticationRequired	xs:boolean		Is authentication required to resolve the shared link?
□ CreatorDisplayName	xs:string	nillable	The display name of the user, who created the shared link.
■ DocNo	xs:int		The document number for the shared link.
□ Filename	xs:string	nillable	The PDF filename that should be used, when the document is downloaded. Only set for "Public" shared links.
□ JwtAccessToken	xs:string	nillable	The JWT access token, which should be used to connect to the system and open the document.
■ PasswordRequired	xs:boolean		Is a password required to resolve the shared link?
■ Result		restriction enum (xs:string) - Success (0) - PasswordInvalid (1) - PasswordRequired (2) - AuthenticationRequired (3) - LinkExpired (4) - UserNotAllowed (5)	The result for resolving the shared link. DocNo and JwtAccessToken is only valid when Result is 'Success'.
■ 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.

Legend: