GetCompanies
Description
This method is used to search for companies both within the Boligmappa system and outside of it using certain third party integrations. Active companies that use Boligmappa are listed first in the results.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
organizationNumber | int | Optional | Not relevant | Number which contains 9 digits E.g. 910747711. |
onlyActiveBoligmappaCompanies | boolean | Mandatory | Not relevant | If this is set to TRUE, only active companies that use Boligmappa are returned. |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
Note
Companies are filtered if the organizationNumber is provided in the input, if not all the companies are returned. If the organizationNumber is given in the input and if the given organizationNumber does not exist in the Boligmappa system, third party services such as Brønnøysundregisteret is used to retrieve the number.
Request - sample input
<GetCompanies>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<organizationNumber>914350840</organizationNumber>
<onlyActiveBoligmappaCompanies>False</onlyActiveBoligmappaCompanies>
<applicationName>test</applicationName>
</MethodParameters>
</GetCompanies>
Response
Type | Description |
---|---|
List<Company> | List of companies |
Currently, Revenue, StartBankStatus and Earning fields in the company object does not display proper values. These fields were added with other new fields to reduce rework during integrations. Implementation to obtain required values for these fields will be completed soon.
Response - sample output
<GetCompanies>
<MethodParameters>
<CompanyArray>
<CompanyArray0>
<Id>197</Id>
<OrganizationNumber>914350840</OrganizationNumber>
<CompanyName>VEGA 1 AS Avdeling Admninistrasjon</CompanyName>
<Address>
<StreetName>c/o KPMG Accounting AS Sørkedalsveien</StreetName>
<HouseNumber>6</HouseNumber>
<HouseLetter isNull="false" />
<ZipCode>0369</ZipCode>
<City>Oslo</City>
</Address>
<Municipality>OSLO</Municipality>
<Longitude>10.7117473</Longitude>
<Latitude>59.9300847</Latitude>
<ContactPerson>pete kale</ContactPerson>
<PhoneNumber>23445678</PhoneNumber>
<Email>harshaniw@99x.lk</Email>
<UseBoligmappa>True</UseBoligmappa>
<Professions attr0="StringArray" isNull="false">
<StringArray0>Elektro/tele</StringArray0>
<StringArray1>Tak/blikkenslager</StringArray1>
</Professions>
<MemberAsssociations attr0="StringArray" isNull="false">
<StringArray0>NELFO</StringArray0>
<StringArray1>VBL</StringArray1>
</MemberAsssociations>
<ContactPersonDetails>
<ContactPersonName>pete kale</ContactPersonName>
<ContactPersonPhone>23232</ContactPersonPhone>
<ContactPersonEmail>harshaniw@99x.lk</ContactPersonEmail>
<ContactPersonRole>ewtrewt fdg</ContactPersonRole>
<ContactPersonImage>http://172.20.1.183:8080/Admin/GetCompanyCompanyContactPersonImage?storageId=914350840_contactperson_Mario_(New_Super_Mario_Bros._2).png</ContactPersonImage>
</ContactPersonDetails>
<CompanyDescription>Company description</CompanyDescription>
<CompanyWebSite isNull="false" />
<CompanyLogo>http://172.20.1.183:8080/Admin/GetCompanyLogo?storageId=914350840_companylogo_6.jpg</CompanyLogo>
<CompanyProfileImage>http://172.20.1.183:8080/Admin/GetCompanyProfileImage?storageId=914350840_companyprofile_Apollo_Nachtansicht_3_MB.jpc.jpg</CompanyProfileImage>
<FacebookAddress isNull="false" />
<ButtonTextForHelpLink>help</ButtonTextForHelpLink>
<HelpLink>www.ikman.lk</HelpLink>
<FranchiserCompanies attr0="FranchiserCompanyOutputArray" isNull="false">
<FranchiserCompanyOutputArray0>
<Name>Test123]</Name>
<OrganizationNumber>123344567</OrganizationNumber>
</FranchiserCompanyOutputArray0>
</FranchiserCompanies>
<EmployeeCount>45</EmployeeCount>
<LastFinancialStatementSubmissionYear>2015</LastFinancialStatementSubmissionYear>
<IsVatRegistered>True</IsVatRegistered>
<IsNavaaRegistered>True</IsNavaaRegistered>
<ShareCapital>30000.00</ShareCapital>
<Equity>137</Equity>
<CreditRating>C1</CreditRating>
<StartBankStatus>test 234@</StartBankStatus>
<Revenue>0</Revenue>
<Earning>0</Earning>
<IsNHOAuthorized>False</IsNHOAuthorized>
</CompanyArray0>
</CompanyArray>
</MethodParameters>
</GetCompanies>
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 |
167 | You are not authorized to use this method |
295 | Third party company search services are unavailable |