AssociateProjectDocumentsToTenant
Description
This method is used by the project owner to associate documents of a project to a relevant tenant. GetTenants service can be used to get all the tenants.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| documentIdList | List<long> | Mandatory | Not relevant | Ids of the list of documents to be associated to the building |
| tenantId | long | Mandatory | Not relevant | tenantId of the selected tenant to get the tenant company |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - sample input
<AssociateProjectDocumentsToTenant>
<MethodParameters>
<UserAuthentication>
<UserName>userName</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<documentIdList attr0="Int64Array" isNull="false">
<Int64Array0>89420</Int64Array0>
<Int64Array1>52233</Int64Array1>
</documentIdList>
<tenantId>40</tenantId>
<applicationName>test</applicationName>
</MethodParameters>
</AssociateProjectDocumentsToTenant>
Response
| Type | Description |
|---|---|
| List<DocumentAssociationStatus> | List of document association statuses |
Response - sample output
<AssociateProjectDocumentsToTenant>
<MethodParameters>
<DocumentAssociationStatusArray>
<DocumentAssociationStatusArray0>
<DocumentId>89420</DocumentId>
<CompanyId>197</CompanyId>
<Status>True</Status>
</DocumentAssociationStatusArray0>
<DocumentAssociationStatusArray1>
<DocumentId>52233</DocumentId>
<CompanyId>197</CompanyId>
<Status>True</Status>
</DocumentAssociationStatusArray1>
</DocumentAssociationStatusArray>
</MethodParameters>
</AssociateProjectDocumentsToTenant>
Exceptions
| Error Code | Description |
|---|---|
| 123 | An exception occurred while processing your request |
| 134 | Document does not exist for the given documentId |
| 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 |
| 223 | The given project is not owned by the company or does not exist, therefore this action cannot be performed |
| 240 | Documents to be copied are not provided |
| 242 | Provide documents from a single project at a time |
| 250 | A document provided does not belong to a project |
| 251 | Documents provided do not belong to a valid project |
| 396 | You have to upgrade your license to do this operation |
| 411 | You need to have the Tenants Add-on to perform this action |
| 416 | tenant Id is not valid (zero or negative) |
| 417 | tenantCompany can not be found for given tenant ID and user's company ID |
| 418 | document Id is not valid (zero or negative) |