Therefore Web API Programming Interface 1.0

Element Name

Element Type

Restrictions

Description

â–  parameters

â–  QueryId

xs:unsignedLong

mandatory

The query Id. Set to 0 for a new query session. Use the Query Id from the response, to continue the query and get more results.

Element Name

Element Type

Restrictions

Description

â–  parameters

â–  Finished

xs:boolean

mandatory

Is the query finished? Or are there more results? If there are more results, use the same query Id in the next request.

â–  QueryId

xs:unsignedLong

mandatory

The query Id. Use it in the request, to continue this query.

â–¡ SharedLinkViewEntries

nillable

The shared links view entries.

≡ WSSharedLinkViewEntry

list nillable

â–¡ CategoryName

xs:string

nillable

The category name.

â–¡ DocumentTitle

xs:string

nillable

The document title of the document, for this shared link.

â–¡ SharedLink

nillable

The shared link.

â–¡ 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?

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.