DesignerListLetterbooksV2

The DesignerListLetterbooksV2 call returns an XML structure that describes all available Letter Books in a particular project. Letter Books usually represent a category or collection of document templates.

For example, the list of Letter Books can be used by the integrating application to help in selecting a document template.

The request requires the following fields next to the standard fields.

Field Type Description
project repositoryobjectname The name of the project of which the Letter Books must be listed.
status name Optional. Only Letter Books that have the requested status are listed. The available statuses are Current, Accepted, or Published. If omitted, Published is used.

The response contains the following fields in addition to the standard fields.

Field Type Description
letterbooks base64Binary A base-64 encoded XML structure that lists the available Letter Books in the project. For more information on the format for this XML, see Format for the definitions.