GetDocumentsByStakeholder
- Indika Anuradha
- Harshani Wickramaarachchi (Unlicensed)
- Eranga Uduwawala (Unlicensed)
Description
This method can be used to get documents using stakeholder
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
| StakeholderId | long | Mandatory | Not Relevant | Selected stakeholder's ID |
Request XML
<GetDocumentsByStakeholder>
<MethodParameters>
<UserAuthentication>
<UserName></UserName>
<Password></Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<StakeholderId>-</StakeholderId>
</input>
<applicationName></applicationName>
</MethodParameters>
</GetDocumentsByStakeholder>
Response
| Parameter | Description |
|---|---|
| GetDocumentsByStakeholderOutput | GetDocumentsByStakeholderOutput model |
GetDocumentsByStakeholderOutput
| Parameter | Type | Description |
|---|---|---|
| Documents | List<DocumentModelForGetDocumentsByStakeholder> | List of DocumentModelForGetDocumentsByStakeholder model objects |
| StakeholderId | long | stakeholder Id |
Response - sample output
<GetDocumentsByStakeholder>
<MethodParameters>
<GetDocumentsByStakeholderOutput>
<Documents attr0="DocumentModelForGetDocumentsByStakeholderArray" isNull="false">
<DocumentModelForGetDocumentsByStakeholderArray0>
<DocumentId></DocumentId>
<FileName></FileName>
<Title></Title>
<Description isNull="true" />
<UpdatedDate></UpdatedDate>
<Url></Url>
<OwnedById></OwnedById>
<OwnedByName></OwnedByName>
<ShowToStakeholder></ShowToStakeholder>
<Status></Status>
<PdfDocId></PdfDocId>
<PdfDocPath></PdfDocPath>
<ApplicationTag></ApplicationTag>
</DocumentModelForGetDocumentsByStakeholderArray0>
</Documents>
<StakeholderId></StakeholderId>
</GetDocumentsByStakeholderOutput>
</MethodParameters>
</GetDocumentsByStakeholder>
Exceptions
| Error Code | Description |
|---|---|
| 110 | Input parameters contain null or invalid data |
| 111 | plantId does not exist for your company or your license does not authorize you to access this plantId |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 167 | You are not authorized to use this method |
| 425 | Stakeholder Id is not valid (zero or negative) |
| 426 | Stakeholder cannot be found for given stakeholder ID |
| 428 | Stakeholder Id does not exist for your company or your license does not authorize you to access this Stakeholder Id |