POST api/app/VendorPortal/TPM/VendorDocuments/ShareVendorDocumentWithBuilder
Request Information
URI Parameters
None.
Body Parameters
VendorDocumentShareBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| BuilderId | integer |
Required |
|
| ERPCCId | integer |
Required |
|
| ERPType | string |
None. |
|
| SupplierAID | string |
Required |
|
| DocumentID | integer |
Required |
Request Formats
application/json, text/json
Sample:
{
"BuilderId": 1,
"ERPCCId": 2,
"ERPType": "sample string 3",
"SupplierAID": "sample string 4",
"DocumentID": 5
}
application/xml, text/xml
Sample:
<VendorDocumentShareBindingModel 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">f8f4b43a-67ba-4440-9a3b-a7a801473884</RequestId> <BuilderId>1</BuilderId> <DocumentID>5</DocumentID> <ERPCCId>2</ERPCCId> <ERPType>sample string 3</ERPType> <SupplierAID>sample string 4</SupplierAID> </VendorDocumentShareBindingModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModelOfVendorDocumentShareResult| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseTime | date |
None. |
|
| ResponseCode | ResponseCode |
None. |
|
| ResponseMessage | string |
None. |
|
| ResponsePermission | string |
None. |
|
| DataSet | VendorDocumentShareResult |
None. |
|
| _internalResponseMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"_internalResponseMessage": "sample string 1",
"ResponseTime": "2026-09-03T23:44:49.0111225+00:00",
"ResponseCode": 0,
"ResponseMessage": "sample string 2",
"ResponsePermission": "sample string 3",
"DataSet": {
"DocumentID": 1,
"SharedCopyDocumentID": 2,
"FileName": "sample string 3",
"IsShared": true
}
}
application/xml, text/xml
Sample:
<ResponseModelOfVendorDocumentShareResult4YL3PCUS 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:DocumentID>1</d2p1:DocumentID>
<d2p1:FileName>sample string 3</d2p1:FileName>
<d2p1:IsShared>true</d2p1:IsShared>
<d2p1:SharedCopyDocumentID>2</d2p1:SharedCopyDocumentID>
</DataSet>
<ResponseCode>NoDataFound</ResponseCode>
<ResponseMessage>sample string 2</ResponseMessage>
<ResponsePermission>sample string 3</ResponsePermission>
<ResponseTime>2026-09-03T23:44:49.0111225+00:00</ResponseTime>
<_internalResponseMessage>sample string 1</_internalResponseMessage>
</ResponseModelOfVendorDocumentShareResult4YL3PCUS>