CopyDocumentsToProject
This method is used to copy a plant/project or unhandled documents to a project.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
input | CopyDocumentsToProjectInput | Mandatory | Not Relevant | CopyDocumentsToProjectInput input model |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Request - Input Sample
<CopyDocumentsToProject>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<DocumentIdList attr0="Int64Array" isNull="false">
<Int64Array0>57226</Int64Array0>
</DocumentIdList>
<ProjectIdList attr0="Int64Array" isNull="false">
<Int64Array0>1109</Int64Array0>
</ProjectIdList>
</input>
<applicationName>test</applicationName>
</MethodParameters>
</CopyDocumentsToProject>
CopyDocumentsToProjectInput
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
DocumentIdList | List | Mandatory | List of DocumentIds to be copied |
ProjectIdList | List | Mandatory | List of ProjectIds where the documents should be copied to |
Note
- Single/Multiple documents can be copied to more than one project at the same time. For example: A user that has 5 documents can combine all 5 documents to more than one project simultaneously.
- Documents cannot be copied to a closed project
- A user is only allowed to copy documents to projects owned or invited
- When a plant document is copied, the Rooms and Devices which are attached to the document are removed from the copied document
- When a project document is copied, the Rooms, Devices and Apartment tags which are attached to the document are removed from the copied document
Response
Type | Description |
---|---|
CopyDocumentsToProjectOutput | CopyDocumentsToProjectOutput model |
CopyDocumentsToProjectOutput
Parameter | Type | Description |
---|---|---|
DocumentCopyStatus | DocumentCopyStatus | DocumentCopyStatus model Info |
Response - output sample
<CopyDocumentsToProject>
<MethodParameters>
<CopyDocumentsToProjectOutput>
<DocumentCopyStatusArray>
<DocumentCopyStatusArray0>
<DocumentId>57226</DocumentId>
<ProjectId>1109</ProjectId>
<Status>True</Status>
<CopiedDocumentId>57469</CopiedDocumentId>
</DocumentCopyStatusArray0>
</DocumentCopyStatusArray>
</CopyDocumentsToProjectOutput>
</MethodParameters>
</CopyDocumentsToProject>
Exceptions
Error Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |
238 | The company of the document is not the same as the current user's company |
240 | Documents to be copied are not provided |
348 | ProjectIds the documents are to be copied to is not provided |
349 | One or more of the ProjectIds provided is a Closed project |
350 | Only the owner of the project or a member of the company is allowed to upload documents |
351 | You are not authorized to perform this action because you are not a member of the project to which the documents are being copied or your license does not authorize you to access this project |
352 | One of the DocumentIds provided is invalid |
353 | One of the ProjectIds provided is invalid |