Description
...
Description
This method is used by company administrators to edit company profiles and special users with the 'Franchiser' role to update details of any company. If null or empty values are provided for optional fields, those will be saved to database replacing they replace the existing database values. Therefore it It is advised to use the GetCompanies web method first and get the method first to obtain details of a company, and then pass use 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
the values that changed in the UpdateCompanyProfile method. This method returns a Boolean value that indicates the status of the update. If the company details are updated using this method, the company profile is displayed to Boligmappa property owners as in the given image.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | UpdateCompanyProfileInput | Mandatory | Not relevant | UpdateCompanyProfile input model |
| applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the ApplicationName should Should be less than or equal to 10 )characters | The name of the integration partner |
Note:
Other company information like like the company name, address, etc. which are not available not available in UpdateCompanyProfileInput, are taken directly from Proff API.
UpdateCompanyProfileInput
Property | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| OrganizationNumber | Int | Mandatory | Not Relevant | Contains 9 digits E.g. 910747711 |
| CompanyTelephoneNumber | string | Mandatory | Not Relevant | E.g. 88998978, +4712345678 (5 or 8 characters) |
| CompanyEmail | string | Mandatory | 50 | E.g. per.christian@boligmappa.no |
| FacebookAddress | string | Optional | 250 | Facebook address of the company |
| CompanyWebSite | string | Optional | 250 | Company website |
| CompanyLogo | ImageInput | Optional | 2 MB | Company logo image input |
| CompanyImage | ImageInput | Optional | 2 MB | Company image input |
| HelpLinkButtonText | string | Optional | 25 | If HelpLink is given this field is mandatory |
| HelpLink | string | Optional | 250 | Eg: www.boligmappa.no. If HelpLinkButtonText is given this field is mandatory. |
| CompanyDescription | string | Optional | 600 | Company description |
| ContactPerson | ContactPerson | Optional | Not Relevant | Contact person details |
Request - sample input
<UpdateCompanyProfile>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<OrganizationNumber>914350840</OrganizationNumber>
<CompanyTelephoneNumber>34567</CompanyTelephoneNumber>
<CompanyEmail>harshaniw@99x.lk</CompanyEmail>
<FacebookAddress isNull="false" />
<CompanyWebSite isNull="false" />
<CompanyLogo>
<Url>http://assets.airbnb.com/press/logos/NBC%20Logo.gif</Url>
<Data isNull="false" />
</CompanyLogo>
<CompanyImage>
<Url>https://thumbs.dreamstime.com/z/business-company-logo-27438277.jpg</Url>
<Data isNull="false" />
</CompanyImage>
<HelpLinkButtonText isNull="false" />
<HelpLink isNull="false" />
<CompanyDescription isNull="false" />
<ContactPerson>
<ContactPersonImage>
<Url>https://engineering.unl.edu/images/staff/Kayla_Person-small.jpg</Url>
<Data isNull="false" />
</ContactPersonImage>
<Name>melanie</Name>
<TelephoneNumber isNull="false" />
<Email isNull="false" />
<Role isNull="false" />
</ContactPerson>
</input>
<applicationName>test</applicationName>
</MethodParameters>
</UpdateCompanyProfile>
Response
Type | Description |
|---|---|
| UpdateCompanyProfileOutputUpdateCompanyProfile Output Model | UpdateCompanyProfileOutput model |
UpdateCompanyProfileOutput
Parameter | Type | CommentsDescription |
|---|---|---|
| IsUpdatedSuccessfully | bool | Is updated successfully |
...
Response - sample output
<UpdateCompanyProfile>
<MethodParameters>
<UpdateCompanyProfileOutput>
<IsUpdatedSuccessfully>True</IsUpdatedSuccessfully>
</UpdateCompanyProfileOutput>
</MethodParameters>
</UpdateCompanyProfile>
Exceptions
Error Code | Description |
|---|---|
113 | Input parameters contain null or invalid data |
| 123 | An exception occurred while processing your request |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name applicationName is not set |
| 167 | You are not authorized to use this web method |
| 258 | Unable to find a company registered for to the given organization numberOrganizationNumber |
| 336 | Contact person name/ contact Person role Name/Role length has exceeded the maximum length character limit allowed (50) |
| 369 | Maximum Email length of Email is exceeded has exceeded the maximum character limit allowed (50) |
| 377 | You are not authorized to perform this operationaction |
| 378 | Maximum length of facebook addressFacebookAddress/ website address/ help link is exceeded HelpLink length has exceeded the maximum character limit allowed (250) |
| 379 | One or more of given Base64 the given Base64 strings as image image inputs are not valid images |
| 380 | If HelpLinkButtonText/HelpLink is given it is mandatory to give the HelpLink/HelpLinkButtonTextHelpLinkButtonText is mandatory |
| 381 | Maximum HelpLinkButtonText length of HelpLinkButtonText is exceeded has exceeded the maximum character limit allowed (25) |
| 382 | One or more of the given images are more than 2MB in size |
| 383 | Maximum CompanyDescription length of Company Description is exceeded has exceeded the maximum character limit allowed (600) |
| 384 | Either Company Email or Contact Person Email is not in the correct formatthe CompanyEmail or ContactPersonEmail is incorrect |
| 385 | Either Company telephone number or Contact person telephone number is not validthe CompanyTelephoneNumber or ContactPerson TelephoneNumber is invalid |
| 386 | One or more of the given URLs Urls for image inputs are not valid Image image file typetypes |
| 387 | Both URL Url and Data are provided for one or more of the inputs. Use either one in each input |
...