Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Checks out the document.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  DocNo

xs:int

mandatory

Sets number of the document to check it out.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  CheckOutSucceeded

xs:boolean

 

Gets whether Check out operation succeeded or not. If the CheckOutSucceeded is false check the SomebodyElseName property to get name of the user who is keeping the document checked out.

â–  CurrentVersionNumber

xs:int

 

Gets the current version number of the document.

â–¡ SomebodyElseName

xs:string

nillable

Gets name of the user if the document is checked out by another user (not by the current one). Otherwise it returns nothing. See also CheckOutSucceeded.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.