SendDocumentsToProject2 - New

Note

• This is an upgraded version of the SendDocumentsToProject method with more metadata. Use this method as the previous is now obsolete.
  

• SendDocumentsToProjectInput is a single input parameter introduced in this method to enclose all the existing input parameters of the previous method in a single place with the exception of the applicationName. 

Description

This method is used to submit document(s) to projects. Once a company is added to a project, all users of that company can send documents to the project using this method. The uploaded documents are shared with limited access to all companies that are connected to the project.  (A user does not have edit/delete access to the documents uploaded by other companies. However complete access is given to any user for documents uploaded by their company. Only the project owner of a company is allowed to copy documents to property/building plants.)

It is possible to tag documents with related devices, rooms, buildings and chapters.   

Request

SendDocumentsToProjectInput

Note

It is mandatory to provide either the ProjectCode or ProjectId. First preference is always given to the ProjectId, if both the ProjectCode and ProjectId are provided.

The mandatory fields in DocumentInput are: FileName, DocumentTypeId, Url/Data, Title, ChapterTagIds, ProfessionId (this should be -1 which indicates "undefined" or provide a valid profession ID for the company).

Request - sample input

<SendDocumentsToProject2>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <Documents attr0="DocumentInputArray" isNull="false">
        <DocumentInputArray0>
          <FileName>title.pdf</FileName>
          <DocumentTypeId>2</DocumentTypeId>
          <Url>http://gahp.net/wp-content/uploads/2017/09/sample.pdf</Url>
          <Title>docName</Title>
          <Description isNull="false" />
          <OrderNumber>34324232</OrderNumber>
          <Data isNull="false" />
          <IsVisibleInBoligmappa>False</IsVisibleInBoligmappa>
          <ProfessionId>1</ProfessionId>
          <BuildingId>0</BuildingId>
          <RoomIds isNull="true" />
          <DeviceId>0</DeviceId>
          <ChapterTagIds isNull="true" />
          <ApartmentTagIds isNull="true" />
        </DocumentInputArray0>
      </Documents>
      <ProjectId>1226</ProjectId>
      <ProjectCode isNull="false" />
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</SendDocumentsToProject2>

Response

SendDocumentsToProjectOutput

Response - sample output

<SendDocumentsToProject2>
  <MethodParameters>
    <SendDocumentsToProjectOutput>
      <Status attr0="DocumentUploadStatusArray" isNull="false">
        <DocumentUploadStatusArray0>
          <DocumentTitle>docName</DocumentTitle>
          <DocumentId>57466</DocumentId>
          <UploadStatusCode>1</UploadStatusCode>
          <ErrorCode>0</ErrorCode>
        </DocumentUploadStatusArray0>
      </Status>
    </SendDocumentsToProjectOutput>
  </MethodParameters>
</SendDocumentsToProject2>

Exceptions