POST api/zip/compress

compressing request and returns compressed file Content in Base64 string

Request Information

URI Parameters

None.

Body Parameters

compression request

SuiteBridge.Models.Zip.ZipCompressRequest

Name	Description	Type	Additional information
Documents	Documents	Collection of SuiteBridge.Models.Zip.FileDocument	None.

Request Formats

application/json, text/json

Sample:

{
  "Documents": [
    {
      "Name": "sample string 1",
      "Content": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Content": "sample string 2"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

response with status 200 OK on successful merge

SuiteBridge.Models.Zip.ZipCompressResponse

Name	Description	Type	Additional information
Archive		SuiteBridge.Models.Zip.FileDocument	None.

Response Formats

application/json, text/json

Sample:

{
  "Archive": {
    "Name": "sample string 1",
    "Content": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ZipCompressResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Archive>
    <Name>sample string 1</Name>
    <Content>sample string 2</Content>
  </Archive>
</ZipCompressResponse>