Note:
This web method is an upgraded version of GetDocumentsForHousingCoopShare web method with more meta data. It is advised to use this web method as the previous is deprecated.
- A single Input parameter (GetDocumentsForHousingCoopShareInputGetDocumentsOfHousingCoopShareInput) 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 OrganizationId and ShareNo. The documents retrieved are those which has been uploaded by professionals and those whose 'visible in boligmappa' is set to true.
Request
| Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input |
| GetDocumentsOfHousingCoopShareInput | Mandatory |
| GetDocumentsOfHousingCoopShare 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) |
GetDocumentsForHousingCoopShareInputGetDocumentsOfHousingCoopShareInput
| Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| OrganizationNumber | int | Mandatory | Organization number of the housing cooperative |
ShareNumber | int | Mandatory | The number uniquely identifying a particular share of a housing cooperative and this is not a part of the matrikkel. |
Response
| Type | Description |
|---|
| GetDocumentsOfHousingCoopShareOutput |
| GetDocumentsOfHousingCoopShare output model |
GetDocumentsForHousingCoopShareOutputGetDocumentsOfHousingCoopShareOutput
| Parameter | Type | Comments |
|---|---|---|
| Documents | List<AuditorDocument> | List of documents for the given Organization number and Share number |
Exceptions
| Error Code | Description |
|---|---|
110 | Input parameters contain null or invalid data |
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 |
171 | Invalid organization number or share number |
| 222 | No Documents found for the given housing cooperative share |