POST api/document/zip/generate/{archiveName}

Generates an archive for the documents generated from the specified URLs and templates.

Request Information

URI Parameters

Name	Description	Type	Additional information
archiveName	Default archive name without the ".zip" extension. If empty, a random archive name is generated.	string	Default value is

Body Parameters

Document archive request DTO.

Collection of DocumentArchiveRequestDTO

Name	Description	Type	Additional information
URL	URL for the GET request to fetch the DTO for. Security token will be propagated to this URL. Domains are not restricted. This value can be empty/null - in that case, the property DTO is inspected.	string	None.
TemplateCategory	Category of the document template.	string	None.
TemplateCode	Code of the document template.	string	None.
DocumentId	Unique ID identifying the document. This same ID is used for deletion.	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "URL": "sample string 1",
    "TemplateCategory": "sample string 2",
    "TemplateCode": "sample string 3",
    "DocumentId": "sample string 4"
  },
  {
    "URL": "sample string 1",
    "TemplateCategory": "sample string 2",
    "TemplateCode": "sample string 3",
    "DocumentId": "sample string 4"
  }
]

text/html

Sample:

[{"URL":"sample string 1","TemplateCategory":"sample string 2","TemplateCode":"sample string 3","DocumentId":"sample string 4"},{"URL":"sample string 1","TemplateCategory":"sample string 2","TemplateCode":"sample string 3","DocumentId":"sample string 4"}]

application/xml, text/xml

Sample:

<ArrayOfDocumentArchiveRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DocumentArchiveRequestDTO>
    <DocumentId>sample string 4</DocumentId>
    <TemplateCategory>sample string 2</TemplateCategory>
    <TemplateCode>sample string 3</TemplateCode>
    <URL>sample string 1</URL>
  </DocumentArchiveRequestDTO>
  <DocumentArchiveRequestDTO>
    <DocumentId>sample string 4</DocumentId>
    <TemplateCategory>sample string 2</TemplateCategory>
    <TemplateCode>sample string 3</TemplateCode>
    <URL>sample string 1</URL>
  </DocumentArchiveRequestDTO>
</ArrayOfDocumentArchiveRequestDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

DocumentArchiveResultDTO

Name	Description	Type	Additional information
Archive	Resulting archive.	DocumentArchiveResultArchiveDTO	None.
Documents	Info on the documents in the archive.	DocumentArchiveResultDocumentDTO	None.

Response Formats

application/json, text/json

Sample:

{
  "Archive": {
    "BlobLink": "sample string 1",
    "ErrorMessage": "sample string 2"
  },
  "Documents": {
    "DocumentId": "sample string 1",
    "BlobLink": "sample string 2"
  }
}

text/html

Sample:

{"Archive":{"BlobLink":"sample string 1","ErrorMessage":"sample string 2"},"Documents":{"DocumentId":"sample string 1","BlobLink":"sample string 2"}}

application/xml, text/xml

Sample:

<DocumentArchiveResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <Archive>
    <BlobLink>sample string 1</BlobLink>
    <ErrorMessage>sample string 2</ErrorMessage>
  </Archive>
  <Documents>
    <BlobLink>sample string 2</BlobLink>
    <DocumentId>sample string 1</DocumentId>
  </Documents>
</DocumentArchiveResultDTO>