DesignerGetLetterbookV2
The DesignerGetLetterbookV2 call returns an XML structure that describes a particular Letter Book. A Letter Book is a collection of Document Templates. Letter Books can be used by business applications to provide users with a list of Document Templates to choose from.
The request requires the following fields next to the standard fields.
Field | Type | Description |
project | repositoryobjectname | The name of the project with the Letter Book to retrieve. |
letterbook | repositoryobjectname | The name of the Letter Book to be retrieved. |
status | name | Optional. The status of the Letter Book to retrieve. 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 |
letterbook | base64Binary | A base-64 encoded XML structure that describes the specified Letter Book. For more information on the format for this XML, see Format for the definitions. |