StopViewingSession |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/StopViewingSession
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StopViewingSession
Stops a viewing session for a specified document stream or for a file from the upload session. This helps freeing up resources.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StopViewingSession
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ DocNo |
xs:int |
nillable |
The number of the document that should no longer be viewed or 0 for newly uploaded documents |
â–¡ VersionNo |
xs:int |
nillable |
The version of the document that should no longer be viewed or 0 for newly uploaded documents |
â–¡ StreamNo |
xs:int |
nillable |
The StreamNo of the document that should no longer be viewed or 0 for newly uploaded documents |
â–¡ UploadSessionId |
xs:string |
nillable GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
The upload session guid of the document that should no longer be viewed or null/undefined for an existing document |
â–¡ StreamNos |
|
nillable |
The StreamNos of the document that should no longer be viewed or null/undefined for an existing document. If StreamNo was already provided, this parameter will be ignored |
≡ int |
xs:int |
list |
|
â–¡ UploadSessionIds |
|
nillable |
Multiple upload session guids of the document that should no longer be viewed or null/undefined for an existing document. If UploadSessionId was already provided, this parameter will be ignored |
≡ guid |
xs:string |
list nillable GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
|
â–¡ ZeroBasedStreamNo |
xs:boolean |
nillable |
Optional bool parameter, that defines if the StreamNo and StreamNos parameter starts at 0 (true) or 1 (false/not-set). |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StopViewingSessionResponse
<Empty message>
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |