Description
This method is used to generate a summary document of all the documents uploaded by professionals to a given property (displayed only if IsVisibleInBoligmappa is set to TRUE when documents are uploaded). It also displays documents uploaded by the property owner, if that property is a publicly shared Boligmappa property. This method is accessible only for Ambita users.
Request
| Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | GeneratePropertySummaryDocumentInput | Mandatory | Not Relevant | Property Summary Document Input |
| applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
BoligmappaNumber or Matrikkel or ShareNumber together with the OrganizationNumber is mandatory for GeneratePropertySummaryDocumentInput. If the user provides several input values, along with the BoligmappaNumber, priority is given to the BoligmappaNumber.
NOTE:
- Verify that the given information corresponds to a single property
- When all the property information is given the priorities are as follows:
- BoligmappaNumber
- ShareNumber together with OrganizationNumber
- Mattrikkel
GeneratePropertySummaryDocumentInput
| Property | Type | Description |
|---|---|---|
| BoligmappaNumber | string | BoligmappaNumber of the Property |
| Matrikkel | Matrikkel | Matrikkel of the property |
| Address | Address | Address of the property |
| UnitNumber | string | UnitNumber of the property |
| BuildingNumber | long | BuildingNumber of the property |
| ShareNumber | int | ShareNumber of the property |
| OrganizationNumber | int | OrganizationNumber of the property |
Request - sample input
Response
| Type | Description |
|---|---|
| GeneratePropertySummaryDocumentOutput | GeneratePropertySummaryDocumentOutput model |
GeneratePropertySummaryDocumentOutput
Parameter | Type | Description |
|---|---|---|
| PropertySummaryDocument | string | Download Url of the generated summary document |
Response - sample input
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
113 | One or more mandatory fields have not been provided |
123 | An exception occurred while processing your request |
167 | You are not authorized to use this method |
| 214 | The given property does not exists in the system |
| 339 | Given data is not enough to identify the property. Provide either ShareNo and OrganizatioNo or Address, UnitNo and BuildingNo as available |
| 394 | No documents were found for the property |
Add Comment