UpdateCompanyProfile

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, they replace the existing database values. It is advised to use the GetCompanies method first to obtain details of a company, and use those details along with 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/Optional	Maximum character length/limit	Description
input	UpdateCompanyProfileInput	Mandatory	Not relevant	UpdateCompanyProfile input model
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

Note

Other company information like the company name, address, etc. which are 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
UpdateCompanyProfileOutput	UpdateCompanyProfileOutput model

UpdateCompanyProfileOutput

Parameter	Type	Description
IsUpdatedSuccessfully	bool	Is updated successfully

Response - sample output

Exceptions

Error Code	Description
113	Input parameters contain null or invalid data
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
167	You are not authorized to use this method
258	Unable to find a company registered to the given OrganizationNumber
336	Contact person Name/Role length has exceeded the maximum character limit allowed (50)
369	Email length has exceeded the maximum character limit allowed (50)
377	You are not authorized to perform this action
378	FacebookAddress/ website address/HelpLink length has exceeded the maximum character limit allowed (250)
379	One or more of the given Base64 strings as image inputs are not valid images
380	If HelpLinkButtonText/HelpLink is given the HelpLink/HelpLinkButtonText is mandatory
381	HelpLinkButtonText length has exceeded the maximum character limit allowed (25)
382	One or more of the given images are more than 2MB in size
383	CompanyDescription length has exceeded the maximum character limit allowed (600)
384	Either the CompanyEmail or ContactPersonEmail is incorrect
385	Either the CompanyTelephoneNumber or ContactPerson TelephoneNumber is invalid
386	One or more of the given Urls for image inputs are not valid image file types
387	Both Url and Data are provided for one or more of the inputs. Use either one in each input