getDocumentDetails Function for SOAP Web Services

Given the fully-qualified Loftware Enterprise SP name of an object managed with Documents permissions Documents permissions are used in Access Control to manage label templates, applications, business rules, forms, images, layer objects, layouts, reusable objects, or workflow templates., this function returns information about that object.

When you create a SOAP Web Service data service for which the WSDL URL is the Loftware Enterprise SP Services Web Services Description Language (WSDL), an operation envelope template containing this function is one of those available. For more information about using SOAP Web Services in Loftware Enterprise SP, see SOAP API for Web Services Integration.

Important! Content in a SOAP Web Service data service or a Web Service integration is case sensitive. This includes names, attributes, and values.

About the syntax documentation

SOAP Operation Envelope (Request)

When you create a SOAP Web Service data service, the XML of the operation envelope template that you select is displayed as the Envelope parameter. Most operation envelope templates include some elements for which you must replace the value with a value appropriate to your environment. If this operation envelope template has such elements, they are described here.

Name	Type	Description
documentFQN	string	The fully-qualified name (FQN) of the label template or other object about which you want to retrieve information

SOAP Response Function

The following is the structure of the Response Function expected as part of a SOAP Response received in response to the preceding type of SOAP Operation Envelope (Request). Any ellipses indicate expected data. For more information, see SOAP API for Web Services Integration.

The response includes one result element with information about the label template, application, business rule, form, image, layer object, layout, reusable object, or workflow template.

<pub:getDocumentDetailsResponse xmlns:pub="http://published.webservices.loftware.com/">

<return success="[true|false]">

<result xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="pub:lwDocumentDto">

<id>...</id>

<name>...</name>

<fullyQualifiedName>...</fullyQualifiedName>

<backgroundFillColor>

<blueValue>...</blueValue>

<greenValue>...</greenValue>

<opacityValue>...</opacityValue>

<redValue>...</redValue>

</backgroundFillColor>

<currentState>...</currentState>

<currentWorkingVersionNumber>...</currentWorkingVersionNumber>

<docType>...</docType>

<documentDpi>...</documentDpi>

<fieldNames>...</fieldNames>

...

<fieldNames>...</fieldNames>

<fontClassifier>...</fontClassifier>

<height>...</height>

<majorVersion>...</majorVersion>

<minorVersion>...</minorVersion>

<printBackgroundFill>...</printBackgroundFill>

<printRotation>...</printRotation>

<shape>...</shape>

<width>...</width>

</result>

</return>

</pub:getDocumentDetailsResponse>

Syntax Tips

Additional information is available about the following items.

lwDocumentDto

This complex element contains data describing an object that is managed by using Documents permissions, such as a label template, application, business rule, form, image, layer object, layout, reusable object, or workflow template. It can include the following elements.

Element	Type	Description
id	long	The ID of the object.
name	string	The name of the object. To refer to a specific version of a version-controlled object, append a colon followed by the version number to the end of the object name.
fullyQualifiedName	string	The fully-qualified name of the object.
backgroundFillColor		See the backgroundFillColor entry that follows for more information. This element is not included in responses to getDocumentName.
currentState	string	For objects that are not version controlled, the value is typically SAVED, but may also be EDITING or FINISHED. For objects that are version controlled, the value is usually either CHECKED_IN or CHECKED_OUT, but may also be FINISHED. This element is not included in responses to getDocumentName.
currentWorkingVersionNumber	string	For a version controlled object, the version number. This element is applicable only to version-controlled objects. For more information, see Managing a Version-Controlled Environment. This element is not included in responses to getDocumentName.
docType	documentTypeEnum	The type of object. The value must be one of the following: DATAENTRY (form) DATASOURCE (business rule) DOCUMENT (label template) IMAGE LAYOUT REUSABLEOBJECT UNKNOWN (if the object type cannot be determined)
documentDpi	int	The resolution in dots per inch that objects on the label should be printed. For more information, see Document DPI in Label Template Properties and Commands.
fieldNames	string	The names of fields in the label template. This element is not included in responses to getDocumentName.
fontClassifier	string	The type of fonts to be used on the label. For more information, see Font Category in Label Template Properties and Commands. This element is not included in responses to getDocumentName.
height	long	The vertical span of the printed label. For more information, see Height in Label Template Properties and Commands.
majorVersion	int	This element is applicable only to version-controlled objects. For more information, see Managing a Version-Controlled Environment. This element is not included in responses to getDocumentName.
minorVersion	int	This element is applicable only to version-controlled objects. For more information, see Managing a Version-Controlled Environment. This element is not included in responses to getDocumentName.
printBackgroundFill	boolean	Whether the fill color is specified in backgroundFillColor is printed. For more information, see Print Fill in Label Template Properties and Commands.
printRotation	int	The orientation of the printed label relative to the print stock. The value should be one of the following: 0 90 180 270
shape	shapeEnum	The appearance of the outside edge of the printed label. The value must be one of the following: RECTANGLE ROUNDED_RECTANGLE UNKNOWN This element is not included in responses to getDocumentName.
width	long	The horizontal span of the printed label. For more information, see Width in Label Template Properties and Commands.

backgroundFillColor

This complex element is used within an lwDocumentDto element and contains data describing the background color, also known as the fill color, for a label template, application, business rule, form, image, layer object, layout, reusable object, or workflow template.

Note: Color printing is possible only if supported by the device and device driver.

Element	Type	Description
blueValue	int	The two-digit value for the blue portion of an RGB color value.
greenValue	int	The two-digit value for the green portion of an RGB color value.
opacityValue	int	The opacity of the fill color. The value should be one of the following: 0 (No fill) 100 (Solid fill)
redValue	int	The two-digit value for the red portion of an RGB color value.