AssociateProjectDocumentsToProperty
This method is used by the project owner to associate documents of a project to the relevant properties.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
documentIdList | List<long> | Mandatory | Not relevant | Ids of the list of documents to be associated to the property |
buildingProperty | Property | Mandatory | 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.
|
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The 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
Type | Description |
---|---|
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 Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | AapplicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |
167 | You are not authorized to use this web method |
223 | The given project is not owned by the company or does not exist, therefore this action cannot be performed |
240 | Documents to be copied are not provided |
241 | Property to which the documents should be associated is not provided |
242 | Provide documents from a single project at a time |
243 | Provide a valid property to associate documents |
244 | Invalid Street Address |
245 | Invalid Matrikkel |
247 | BoligmappaNumber is mandatory for a property project |
250 | A document provided does not belong to the project |
251 | Documents provided do not belong to a valid project |