SearchProject

Description

This method is used to search for projects by providing several inputs.

Request

Parameter

Type

Mandatory/Optional

Maximum character length/limit

Description

input

SearchProjectInput

MandatoryNot RelevantSearchProjectInput model
applicationName

string

Mandatory

Should be less than or equal to 10 characters

The name of the integration partner

Request - sample input

<SearchProject>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <ProjectCode>WAA0002-N6</ProjectCode>
      <ProjectName isNull="false" />
      <OrganizationNumber>0</OrganizationNumber>
      <CompanyName isNull="false" />
      <BoligmappaNumber isNull="false" />
      <Matrikkel>
        <Knr>0</Knr>
        <Gnr>0</Gnr>
        <Bnr>0</Bnr>
        <Fnr>0</Fnr>
        <Snr>0</Snr>
      </Matrikkel>
      <Address>
        <StreetName isNull="false" />
        <HouseNumber>0</HouseNumber>
        <HouseLetter isNull="false" />
        <ZipCode isNull="false" />
        <City isNull="false" />
      </Address>
      <InternalProjectReference isNull="false" />
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</SearchProject>

SearchProjectInput

Parameter

Type

Mandatory/Optional

Description

ProjectCodestringOptionalProject code of the project (Eg: AAA1234-B2)
ProjectNamestringOptionalName of the project (Matches even if a part of the name is given. Eg. if the project name is test project you can retrieve it by providing only test)
OrganizationNumberintOptionalOrganization number of a company that is involved in the project
CompanyNamestringOptionalName of a company which is involved in the project (Matches even if a part of the name is given. Eg. if the company name is test company you can retrieve it by providing only test)
BoligmappaNumberstringOptionalBoligmappa number of a property/building which is connected to the project
MatrikkelMatrikkelOptionalMatrikkel of a property which is connected to the project
AddressAddressOptionalAddress of a property/building which is connected to the project
InternalProjectReferencestringOptionalInternal project reference of a project company that is involved in the project

Note:

  • All inputs are optional and any number of inputs are allowed.  However, at least one input is required to search for a project.
  • None of the input parameters are given priority over another. To avoid obtaining unexpected results, do not provide contradictory search combinations
    Eg. If the 'ProjectCode' of one project and the 'ProjectName' of another project is supplied, no matching project will be found. Instead, the error code 358 will be thrown.

Response

Type

Description

SearchProjectOutputSearchProjectOutput model


SearchProjectOutput

Parameter

Type

Description

ProjectDetailsList <ProjectResult>List of Projects along with company, property and building details


Response - sample output

<SearchProject>
  <MethodParameters>
    <SearchProjectOutput>
      <ProjectDetails attr0="ProjectResultArray" isNull="false">
        <ProjectResultArray0>
          <ProjectId>1142</ProjectId>
          <ProjectName>hhhhhhhhhhhh</ProjectName>
          <ProjectCode>WAA0002-N6</ProjectCode>
          <ProjectType>0</ProjectType>
          <Description isNull="true" />
          <ProjectStatus>1</ProjectStatus>
          <StartedDate>7/31/2017 5:38:40 PM</StartedDate>
          <UpdatedDate>7/31/2017 5:38:40 PM</UpdatedDate>
          <ProjectContactPersonName>helena</ProjectContactPersonName>
          <ProjectContactPersonEmail>helena@test.no</ProjectContactPersonEmail>
          <ProjectContactPersonNumber>11111222</ProjectContactPersonNumber>
          <ProjectCompanies attr0="CompanyDetailsArray" isNull="false">
            <CompanyDetailsArray0>
              <Name>Test123]</Name>
              <OrganizationNumber>123344567</OrganizationNumber>
              <ContactEmail>helena@test.no</ContactEmail>
              <ContactPerson>helena</ContactPerson>
              <IsOwnerCompany>1</IsOwnerCompany>
              <Reference isNull="true" />
            </CompanyDetailsArray0>
          </ProjectCompanies>
          <Building isNull="true" />
          <Property isNull="true" />
        </ProjectResultArray0>
      </ProjectDetails>
    </SearchProjectOutput>
  </MethodParameters>
</SearchProject>

Exceptions

Error Code

Description

123

An exception occurred while processing your request

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

146

The applicationName is not set

358No matching results found for your inputs
359Please provide at least one input