Description
This web method returns a Boolean value indicating update is success or not . This web method can be accessed by company admin users to edit their company profiles and Special users with 'Franchiser' role to update details of any company. If null or empty values provided for optional fields, those will be saved to database replacing the existing database values. Therefore it is advised to use GetCompanies web method first and get the details of company, and then pass those details along with changed values to UpdateCompanyProfile web method.
If you have updated your company details properly using this web method, your company profile will be displayed to Boligmappa Property owners as follows
Request
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input | UpdateCompanyProfileInput | Mandatory | UpdateCompanyProfile 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) |
Note: Other company information like company name, address, etc. which are not available in UpdateCompanyProfileInput, are taken directly from Proff API
Response
Type | Description |
|---|---|
| UpdateCompanyProfileOutput | UpdateCompanyProfile Output Model |
UpdateCompanyProfileOutput
Parameter | Type | Comments |
|---|---|---|
| IsUpdatedSuccessfully | bool | Is updated successfully |
Exceptions
Error Code | Description |
|---|---|
113 | Input parameters contain null or invalid data |
| 123 | An exception occurred 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 |
| 258 | Unable to find a company registered for the given organization number |
| 336 | Contact person name/ contact Person role has exceeded maximum length (50) |
| 369 | Maximum length of Email is exceeded (50) |
| 377 | You are not authorized to perform this operation |
| 378 | Maximum length of facebook address/ website address/ help link is exceeded (250) |
| 379 | One or more of given Base64 strings as image inputs are not valid images |
| 380 | If HelpLinkButtonText/HelpLink is given it is mandatory to give HelpLink/HelpLinkButtonText |
| 381 | Maximum length of HelpLinkButtonText is exceeded (25) |
| 382 | One or more of the given images are more than 2MB in size |
| 383 | Maximum length of Company Description is exceeded (600) |
| 384 | Either Company Email or Contact Person Email is not in the correct format |
| 385 | Either Company telephone number or Contact person telephone number is not valid |
| 386 | One or more of the given URLs for image inputs are not valid Image file type |
| 387 | Both URL and Data are provided for one or more of the inputs. Use either one in each input |