Description
This Web method generates is used to generate a summary document of all the documents uploaded by professionals to a given Property (setting show in Boligmappa value True). This summary document will contains property (displayed only if IsVisibleInBoligmappa is set to TRUE when documents are uploaded). It also displays documents uploaded by the property owner also, if that property is a Publicly Shared publicly shared Boligmappa property. This Web method is accessible only for Ambita users.
Request
| Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | GeneratePropertySummaryDocumentInput | Mandatory | Not Relevant | Property Summary Document Input |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should Should be less than or equal to 10 ) |
...
| characters | The name of the integration partner |
BoligmappaNumber or Matrikkel or Share Number ShareNumber together with Organisation Number the OrganizationNumber is mandatory for GeneratePropertySummaryDocumentInput. If the user has provided many provides several input values, along with Boligmappa Number priority will be the BoligmappaNumber, priority is given to Boligmappa Numberthe BoligmappaNumber.
NoteNOTE:
- Please verify Verify that the given information corresponds to a single property.
- When all the property information is given the priorities are as follows:
- Boligmappa numberBoligmappaNumber
- Share number ShareNumber together with organisation number
- Mattrikkel
- 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 | CommentsDescription |
|---|---|---|
| PropertySummaryDocument | string | Download URL 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. Please provide Provide either ShareNo and OrganizatioNo or Address, UnitNo and BuildingNo as available |
| 394 | No Documents are documents were found for the property |