|
TestCheckOutDocument |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/TestCheckOutDocument
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/TestCheckOutDocument
Tests if check out is possible for given document.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/TestCheckOutDocument
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– DocNo |
xs:int |
mandatory |
Sets number of the document to test whether a check out is possible for this document. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/TestCheckOutDocumentResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ CheckOutStatus |
|
optional nillable |
Gets checkout status of the document. |
â– CheckOutState |
|
optional restriction enum (xs:string) - NotCheckedOut (0) - CheckedOutByCurrentUser (1) - CheckedOutBySomebodyElse (2) |
Gets check-out status value. |
â–¡ SomebodyElseName |
xs:string |
optional 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 CheckOutState. |
â– CurrentVersionNumber |
xs:int |
optional |
Gets the current version number for the document. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
Unbounded element (List of elements). |
Normal |
Optional element. |
Bold |
Mandatory element. |
