Note:
This web method is an upgraded version of GetDocumentsByMatrikkel web method with more meta data. It is advised to use this web method as the previous is deprecated.
- A single Input parameter (GetDocumentsByMatrikkelInputGetDocumentsUsingMatrikkelInput) is introduced in this web method in order to enclose all the existing input parameters of the old web method except for the Application name in a single place.
Authorization
Special level of permission is required to access this web service and please request permission from Boligmappa.
Description
This web method can be used to retrieve documents associated to a property by matrikkel. The documents retrieved are those which has been uploaded by professionals and those whose 'visible in boligmappa' is set to true.
Housing cooperatives are not supported in this web method.
Note
Only Auditors can access this web method
Request
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input |
| GetDocumentsUsingMatrikkelInput | Mandatory |
| GetDocumentsUsingMatrikkel input model | |||
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName should be less than or equal to 10) |
...
GetDocumentsUsingMatrikkelInput
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| Matrikkel | Matrikkel | Mandatory | Matrikkel Information |
Response
Type | Description |
|---|
| GetDocumentsUsingMatrikkelOutput |
| GetDocumentsUsingMatrikkel Output |
...
GetDocumentsUsingMatrikkelOutput
Parameter | Type | Comments |
|---|---|---|
AuditorDocuments | List<AuditorDocument> | List of AuditorDocuments |
Exceptions
Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
109 | Given Matrikkel does not exist in system |
123 | An exception occured while processing your request |
| 138 | ApplicationName length is exceeded maximum allowed character limit (10) |
| 146 | The application name is not set |
167 | You are not authorized to use this web method |
168 | Given is a matrikkel of a Housing cooperative. This type of property is not supported in this method |
| 188 | Matrikkel is not provided |