GetCompaniesWithJobDetails

Description

This method is used to return all job details of the properties handled by the company.  It does not validate if the given company is active and returns a list of all the companies. However, if the BoligmappaNumber is given, only the jobs specific to the given number is displayed. A special level of permission is required to access this method as it is only available for users with FinnitServer credentials. 

Note 

  • Use the AuthenticateToFinnIt method to check the active or inactive status of a company
  • The company object in the response is only updated with the details listed below:
    • CompanyId
    • organisation Number
    • Company Name
    • IsNHO authorized
    • FranchisedCompaniesList


Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription

input

GetCompaniesWithJobDetailsInput

Mandatory

Not relevant

Model containing an array of CompanyIds and a single BoligmappaNumber

applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

 

GetCompaniesWithJobDetailsInput

Parameter

Type

Mandatory/Optional

Description

CompanyIdListlong[]MandatoryThe CompanyIds of the required companies
BoligMappaNumberstringoptionalThe BoligmappaNumber of the specific property (Invalid or a blank BolimappaNumber will result in making the HasWorkedInProperty to be false for every company)

Request - sample input

<GetCompaniesWithJobDetails>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <CompanyIdList attr0="Int64Array" isNull="false">
        <Int64Array0>197</Int64Array0>
      </CompanyIdList>
      <BoligMappaNumber isNull="false" />
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetCompaniesWithJobDetails>


Response

TypeDescription

List<CompanyWithJobDetails

An object array containing all job details of a company and if given the job details specific to the BoligmappaNumber

ErrorCodeAn exception code regarding the given BoligmappaNumber (null if no error)


Response - sample output

<GetCompaniesWithJobDetails>
  <MethodParameters>
    <GetCompaniesWithJobDetailsOutput>
      <CompanyJobDetailList attr0="CompanyWithJobDetailsArray" isNull="false">
        <CompanyWithJobDetailsArray0>
          <Company>
            <Id>197</Id>
            <OrganizationNumber>914350840</OrganizationNumber>
            <CompanyName>VEGA 1 AS Avdeling Admninistrasjon</CompanyName>
            <Address isNull="true" />
            <Municipality isNull="true" />
            <Longitude>0</Longitude>
            <Latitude>0</Latitude>
            <ContactPerson isNull="true" />
            <PhoneNumber isNull="true" />
            <Email isNull="true" />
            <UseBoligmappa>False</UseBoligmappa>
            <Professions isNull="true" />
            <MemberAsssociations isNull="true" />
            <ContactPersonDetails isNull="true" />
            <CompanyDescription isNull="true" />
            <CompanyWebSite isNull="true" />
            <CompanyLogo isNull="true" />
            <CompanyProfileImage isNull="true" />
            <FacebookAddress isNull="true" />
            <ButtonTextForHelpLink isNull="true" />
            <HelpLink isNull="true" />
            <FranchiserCompanies attr0="FranchiserCompanyOutputArray" isNull="false">
              <FranchiserCompanyOutputArray0>
                <Name>Test123]</Name>
                <OrganizationNumber>123344567</OrganizationNumber>
              </FranchiserCompanyOutputArray0>
            </FranchiserCompanies>
            <EmployeeCount>0</EmployeeCount>
            <LastFinancialStatementSubmissionYear>0</LastFinancialStatementSubmissionYear>
            <IsVatRegistered>False</IsVatRegistered>
            <IsNavaaRegistered>False</IsNavaaRegistered>
            <ShareCapital>0</ShareCapital>
            <Equity>0</Equity>
            <CreditRating isNull="true" />
            <StartBankStatus isNull="true" />
            <Revenue>0</Revenue>
            <Earning>0</Earning>
            <IsNHOAuthorized>False</IsNHOAuthorized>
          </Company>
          <JobDetails>
            <HasWorkedInProperty>False</HasWorkedInProperty>
            <noOfTotalJobsDone>1210</noOfTotalJobsDone>
          </JobDetails>
          <ErrorCode isNull="true" />
        </CompanyWithJobDetailsArray0>
      </CompanyJobDetailList>
      <ErrorCode isNull="true" />
    </GetCompaniesWithJobDetailsOutput>
  </MethodParameters>
</GetCompaniesWithJobDetails>

Exceptions

Error CodeDescription

108

Input parameters contain invalid or null data

123

An exception occured while processing your request

224Invalid CompanyId 
239Invalid BoligmappaNumber

138

applicationName length has exceeded the maximum character limit allowed (10) 

146The applicationName is not set

167

You are not authorized to use this method