POST api/app/VendorPortal/TPM/VendorDocuments/BulkDownloadVendorDocuments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BuilderId	integer	Required
ERPCCId	integer	Required
ERPType	string	None.
SupplierAID	string	Required
DocumentIDs	Collection of integer	Required

Request Formats

application/json, text/json

Sample:

{
  "BuilderId": 1,
  "ERPCCId": 2,
  "ERPType": "sample string 3",
  "SupplierAID": "sample string 4",
  "DocumentIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<VendorDocumentBulkIdsBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Central.API.Common.BindingModel.VendorPortal">
  <RequestId xmlns="http://schemas.datacontract.org/2004/07/Central.API.Enterprise.BindingModels">ee14d94d-8070-48c2-88a0-a01b5af5fd7e</RequestId>
  <BuilderId>1</BuilderId>
  <DocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DocumentIDs>
  <ERPCCId>2</ERPCCId>
  <ERPType>sample string 3</ERPType>
  <SupplierAID>sample string 4</SupplierAID>
</VendorDocumentBulkIdsBindingModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModelOfVendorDocumentBulkDownloadResult

Name	Type	Additional information
ResponseTime	date	None.
ResponseCode	ResponseCode	None.
ResponseMessage	string	None.
ResponsePermission	string	None.
DataSet	VendorDocumentBulkDownloadResult	None.
_internalResponseMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "_internalResponseMessage": "sample string 1",
  "ResponseTime": "2026-10-31T11:56:02.029078+00:00",
  "ResponseCode": 0,
  "ResponseMessage": "sample string 2",
  "ResponsePermission": "sample string 3",
  "DataSet": {
    "Results": [
      {
        "DocumentID": 1,
        "Success": true,
        "FileName": "sample string 3",
        "BlobUrl": "sample string 4",
        "PreviewUrl": "sample string 5",
        "ErrorMessage": "sample string 6"
      },
      {
        "DocumentID": 1,
        "Success": true,
        "FileName": "sample string 3",
        "BlobUrl": "sample string 4",
        "PreviewUrl": "sample string 5",
        "ErrorMessage": "sample string 6"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseModelOfVendorDocumentBulkDownloadResult4YL3PCUS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Central.API.Enterprise.BindingModels">
  <DataSet xmlns:d2p1="http://schemas.datacontract.org/2004/07/Central.API.Common.DataProvider.Model.VendorPortal">
    <d2p1:Results>
      <d2p1:VendorDocumentBulkDownloadItemResult>
        <d2p1:BlobUrl>sample string 4</d2p1:BlobUrl>
        <d2p1:DocumentID>1</d2p1:DocumentID>
        <d2p1:ErrorMessage>sample string 6</d2p1:ErrorMessage>
        <d2p1:FileName>sample string 3</d2p1:FileName>
        <d2p1:PreviewUrl>sample string 5</d2p1:PreviewUrl>
        <d2p1:Success>true</d2p1:Success>
      </d2p1:VendorDocumentBulkDownloadItemResult>
      <d2p1:VendorDocumentBulkDownloadItemResult>
        <d2p1:BlobUrl>sample string 4</d2p1:BlobUrl>
        <d2p1:DocumentID>1</d2p1:DocumentID>
        <d2p1:ErrorMessage>sample string 6</d2p1:ErrorMessage>
        <d2p1:FileName>sample string 3</d2p1:FileName>
        <d2p1:PreviewUrl>sample string 5</d2p1:PreviewUrl>
        <d2p1:Success>true</d2p1:Success>
      </d2p1:VendorDocumentBulkDownloadItemResult>
    </d2p1:Results>
  </DataSet>
  <ResponseCode>NoDataFound</ResponseCode>
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponsePermission>sample string 3</ResponsePermission>
  <ResponseTime>2026-10-31T11:56:02.029078+00:00</ResponseTime>
  <_internalResponseMessage>sample string 1</_internalResponseMessage>
</ResponseModelOfVendorDocumentBulkDownloadResult4YL3PCUS>