Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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 (GetDocumentsOfHousingCoopShareInput) 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

ParameterTypeMandatory/OptionalComments
inputGetDocumentsOfHousingCoopShareInputMandatoryGetDocumentsOfHousingCoopShare Input model

applicationName

stringMandatoryThird party application identifier, identifying the client consuming the web service – (Length of the applicationName should be less than or equal to 10)

 

GetDocumentsOfHousingCoopShareInput


ParameterTypeMandatory/OptionalComments
OrganizationNumberintMandatoryOrganization number of the housing cooperative

ShareNumber

intMandatoryThe number uniquely identifying a particular share of a housing cooperative and this is not a part of the matrikkel.

Response

TypeDescription
GetDocumentsOfHousingCoopShareOutputGetDocumentsOfHousingCoopShare output model

 

GetDocumentsOfHousingCoopShareOutput


ParameterTypeComments
DocumentsList<AuditorDocument>List of documents for the given Organization number and Share number


Exceptions

Error CodeDescription

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

222No Documents found for the given housing cooperative share
  • No labels