SendDocumentsToPlant - New

Note

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

• SendDocumentsToPlantInput 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 Boligmappa. The document is associated with a specific property and company through a plantId. The company is identified by the current user's credentials. It is possible to tag a document with related rooms, chapter tags and a device. 

Request

Note

• No errors are thrown when 0 is provided for the RoomIds as it considered as no RoomId provided.

SendDocumentsToPlantInput

Note

The following parameters of DocumentInput Model are mandatory for this method. 

• FileName
• DocumentTypeId
• Url / Data (*either the Url or the data must be provided)
• Title
• OrderNumber
• ProfessionId

Request - input sample

<SendDocumentsToPlant>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <PlantId>6731</PlantId>
      <PropertyOwnerEmail isNull="false" />
      <Documents attr0="DocumentInputArray" isNull="false">
        <DocumentInputArray0>
          <FileName>test.pdf</FileName>
          <DocumentTypeId>2</DocumentTypeId>
          <Url>https://www.ets.org/Media/Tests/GRE/pdf/gre_research_validity_data.pdf</Url>
          <Title>test</Title>
          <Description isNull="false" />
          <OrderNumber>34324232</OrderNumber>
          <Data isNull="false" />
          <IsVisibleInBoligmappa>False</IsVisibleInBoligmappa>
          <ProfessionId>1</ProfessionId>
          <BuildingId>0</BuildingId>
          <RoomIds attr0="Int64Array" isNull="false">
            <Int64Array0>0</Int64Array0>
          </RoomIds>
          <DeviceId>0</DeviceId>
          <ChapterTagIds isNull="true" />
          <ApartmentTagIds attr0="Int32Array" isNull="false">
            <Int32Array0>0</Int32Array0>
          </ApartmentTagIds>
        </DocumentInputArray0>
      </Documents>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</SendDocumentsToPlant>

Response

SendDocumentsToPlantOutput

Response - output sample

<SendDocumentsToPlant>
  <MethodParameters>
    <SendDocumentsToPlantOutput>
      <Statuses attr0="DocumentUploadStatusArray" isNull="false">
        <DocumentUploadStatusArray0>
          <DocumentTitle>test</DocumentTitle>
          <DocumentId>57463</DocumentId>
          <UploadStatusCode>1</UploadStatusCode>
          <ErrorCode>0</ErrorCode>
        </DocumentUploadStatusArray0>
      </Statuses>
      <SummaryDocument isNull="true" />
    </SendDocumentsToPlantOutput>
  </MethodParameters>
</SendDocumentsToPlant>

Exceptions