POST api/batch/{batch_id}/documents/category/bulk-download

Request Information

URI Parameters

Name	Description	Type	Additional information
batch_id		integer	Required

Body Parameters

BulkDownloadRequestModel

Name	Description	Type	Additional information
categoryIds		Collection of integer	None.
filename		string	None.

Request Formats

application/json, text/json

Sample:

{
  "categoryIds": [
    1,
    2
  ],
  "filename": "sample string 1"
}

text/html

Sample:

{"categoryIds":[1,2],"filename":"sample string 1"}

application/xml, text/xml

Sample:

<BulkDownloadRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
  <categoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </categoryIds>
  <filename>sample string 1</filename>
</BulkDownloadRequestModel>

multipart/form-data

Sample:

<BulkDownloadRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><categoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:int>1</d2p1:int><d2p1:int>2</d2p1:int></categoryIds><filename>sample string 1</filename></BulkDownloadRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.