DownloadPersonalInformationDocument - Rest API
Description
This method is used to generate and download a document containing all the personal information of a professional.
Rest Endpoint
Staging environment - testwebservice2.boligmappa.no/PersonalDocumentDownload
Production environment - webservice2.boligmappa.no/PersonalDocumentDownload
Request Parameters
Request Header
Note - Content-Type should be application/x-www-form-urlencoded
Parameter | Type | Mandatory / Optional | Description |
---|---|---|---|
userName | String | Mandatory | Username of the company user |
password | String | Mandatory | Password of the company user |
Request Body
Parameter | Type | Mandatory / Optional | Description |
---|---|---|---|
applicationName | String | Mandatory | The application name of the integration patner |
Response
Response - Success
If the call is successful the document will be downloaded
Response - Fail
Parameter | Type | Description |
---|---|---|
Code | String | Error code |
Message | String | Description of the error |
Exceptions
Error Code | Description |
---|---|
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |