EditDocument

Description

This method is used to edit a document that is uploaded to a plant (property plant/ building plant), a project (property project /building project / anonymous project) or a tenant.

Request

EditDocumentInput 

Note

• Following parameters of the DocumentEditDetailsInput Model are mandatory for this method. 
• Title
• DocumentType/ChapterTagIds
• Maximum 3 chapter tags can be given in the input
• Rooms and Devices can only be tagged for property plant/ project documents
• Apartment tag Ids can only be given for project documents. Apartment tag Ids given for a plant document are ignored.
• If the document is not being stored in your database or details to edit the fields are unavailable, implement it as follows:
  • Step 1 : Use GetDocument - New method to retrieve the document from the Boligmappa system.
  • Step 2 : Fill out the fields in DocumentEditDetailsInput model with the output from GetDocument - New when entering data.
  • Step 3 : Send DocumentEditDetailsInput to EditDocument method.

          Or else, directly call the EditDocument method.

• Fields left empty/null are replaced with empty/null values.
• Project owner is allowed to edit documents uploaded by invitees, but project owner will not be able to change IsVisibleInBoligmappa and Profession. Values sent for those fields, in case of project owner editing an invitee document, are ignored.

Request - sample input

<EditDocument>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <DocumentId>57226</DocumentId>
      <Document>
        <Title>download100.png</Title>
        <OrderNo isNull="false" />
        <DocumentType>13</DocumentType>
        <Description>A new doc for chapter 2</Description>
        <ProfessionId>1</ProfessionId>
        <ChapterTagIds attr0="Int32Array" isNull="false">
          <Int32Array0>2</Int32Array0>
        </ChapterTagIds>
        <PropertyUnitIdList isNull="true" />
        <DeviceId>0</DeviceId>
        <ApartmentTagIdList isNull="true" />
        <IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>

 
      </Document>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</EditDocument>

Response

EditPlantDocumentOutput 

Response - sample output

<EditDocument>
  <MethodParameters>
    <EditDocumentOutput>
      <EditStatus>
        <DocumentTitle>download100.png</DocumentTitle>
        <DocumentId>57226</DocumentId>
        <EditStatusCode>1</EditStatusCode>
      </EditStatus>
    </EditDocumentOutput>
  </MethodParameters>
</EditDocument>

Exceptions