Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Returns check-out status of existing Thereforeâ„¢ document.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  DocNo

xs:int

mandatory

Sets number of the document to get status for it.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ CheckOutStatus

 

nillable

Gets check-out status of the document.

â–  CheckOutState

 

 

restriction enum (xs:string)

- NotCheckedOut (0)

- CheckedOutByCurrentUser (1)

- CheckedOutBySomebodyElse (2)

Gets check-out status value.

â–¡ 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 CheckOutState.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.