AssociateProjectDocumentsToProperty

This method is used by the project owner to associate documents of a project to the relevant properties.

Request

ParameterTypeMandatory/Optional Maximum character length/limitDescription 
documentIdListList<long>Mandatory Not relevantIds of the list of documents to be associated to the property 
buildingPropertyPropertyMandatory Not relevant

Property to which the documents should be associated.

Note : Use the LookupPropertiesForBuilding or any other relevant method for validation as property information is not validated by this method. 

  • The Address, Matrikkel, BuildingNumber and UnitNumber are mandatory for the Property if the BoligmappaNumber is not provided.
applicationNamestringMandatory Should be less than or equal to 10 charactersThe name of the integration partner

 

Note:

  • The BuildingIteration is no longer required as it will be made obsolete in the future.


Request - sample input

<AssociateProjectDocumentsToProperty>
  <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>57226</Int64Array0>
    </documentIdList>
    <buildingProperty>
      <BoligmappaNumber>AAF8476</BoligmappaNumber>
      <Matrikkel>
        <Knr>0</Knr>
        <Gnr>0</Gnr>
        <Bnr>0</Bnr>
        <Fnr>0</Fnr>
        <Snr>0</Snr>
      </Matrikkel>
      <ShareNumber>0</ShareNumber>
      <UnitNumber isNull="false" />
      <OrganizationNumber>0</OrganizationNumber>
      <BuildingNumber>0</BuildingNumber>
      <Iteration>0</Iteration>
      <Address>
        <StreetName isNull="false" />
        <HouseNumber>0</HouseNumber>
        <HouseLetter isNull="false" />
        <ZipCode isNull="false" />
        <City isNull="false" />
      </Address>
      <PropertyOwners attr0="PropertyOwnerArray" isNull="false">
        <PropertyOwnerArray0>
          <FirstName isNull="false" />
          <LastName isNull="false" />
          <DefaultAddress isNull="false" />
          <OrganizationNumber>0</OrganizationNumber>
        </PropertyOwnerArray0>
      </PropertyOwners>
    </buildingProperty>
    <applicationName>test</applicationName>
  </MethodParameters>
</AssociateProjectDocumentsToProperty>

Response

TypeDescription

List<DocumentAssociationStatus>

 
List of document association statuses


Response - sample output

<AssociateProjectDocumentsToProperty>
  <MethodParameters>
    <DocumentAssociationStatusArray>
      <DocumentAssociationStatusArray0>
        <DocumentId>57226</DocumentId>
        <CompanyId>197</CompanyId>
        <Status>True</Status>
      </DocumentAssociationStatusArray0>
    </DocumentAssociationStatusArray>
  </MethodParameters>
</AssociateProjectDocumentsToProperty>

Exceptions

Error CodeDescription
123An exception occurred while processing your request
138AapplicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
167You are not authorized to use this web method
223The given project is not owned by the company or does not exist, therefore this action cannot be performed
240Documents to be copied are not provided
241Property to which the documents should be associated is not provided
242Provide documents from a single project at a time
243Provide a valid property to associate documents
244Invalid Street Address
245Invalid Matrikkel
247BoligmappaNumber is mandatory for a property project
250A document provided does not belong to the project
251Documents provided do not belong to a valid project