Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

This web method can be used to ensure if the project does exist.

...

Description

This method is only used to verify whether a project exists.


Request

ParameterTypeMandatory/Optional
Comments
Maximum character length/limitDescription
projectCode

string

MandatoryNot RelevantThe code of the project that
has to be validated.
requires validation
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


Request - sample input

<ValidateProject>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <projectCode>WAA0002-N6</projectCode>
    <applicationName>test</applicationName>
  </MethodParameters>
</ValidateProject>

Response

TypeDescription
ProjectDetails of the project to be validated


Response - sample output 

<ValidateProject>
  <MethodParameters>
    <Project actualtype="Project" basetype="Project">
      <ProjectId>1142</ProjectId>
      <ProjectName>hhhhhhhhhhhh</ProjectName>
      <ProjectCode>WAA0002-N6</ProjectCode>
      <ProjectType>0</ProjectType>
      <BoligmappaNumber isNull="true" />
      <IsAdmin>False</IsAdmin>
      <OwnerCompany>
        <Id>3928</Id>
        <OrganizationNumber>123344567</OrganizationNumber>
        <CompanyName>Test123]</CompanyName>
        <Address>
          <StreetName>Main Street,</StreetName>
          <HouseNumber>0</HouseNumber>
          <HouseLetter isNull="false" />
          <ZipCode>1234</ZipCode>
          <City isNull="false" />
        </Address>
        <Municipality isNull="true" />
        <Longitude>0</Longitude>
        <Latitude>0</Latitude>
        <ContactPerson>hellen</ContactPerson>
        <PhoneNumber>12345678</PhoneNumber>
        <Email>hellen@test.no</Email>
        <UseBoligmappa>False</UseBoligmappa>
        <Professions attr0="StringArray" isNull="false">
          <StringArray0>Elektro/tele</StringArray0>
        </Professions>
        <MemberAsssociations attr0="StringArray" isNull="false">
          <StringArray0>Elektriker</StringArray0>
        </MemberAsssociations>
        <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 isNull="true" />
        <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 isNull="true" />
      </OwnerCompany>
      <Description isNull="true" />
      <ProjectStatus>1</ProjectStatus>
      <StartedDate>7/31/2017 5:38:40 PM</StartedDate>
      <UpdatedDate isNull="true" />
Therefore, it is not advisable       <ProjectCompanies attr0="CompanyArray" Note : Please note that all the fields in the project model will not be returned as the result. Only following information are retuned

  • Project details - ProjectId, ProjectName, ProjectCode, ProjectType, StartedDate, BoligmappaNumber, IsAdmin.
  • Address - ProjectAddress
  • ProjectCompanies
    • Id
    • CompanyName
    • OrganizationNumber
  • OwnerCompany
    • Id
    • CompanyName
    • OrganizationNumber

isNull="false">
        <CompanyArray0>
          <Id>3928</Id>
          <OrganizationNumber>123344567</OrganizationNumber>
          <CompanyName>Test123]</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 isNull="true" />
          <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 isNull="true" />
        </CompanyArray0>
      </ProjectCompanies>
      <ProjectAddress>
        <StreetName isNull="true" />
        <HouseNumber>0</HouseNumber>
        <HouseLetter isNull="true" />
        <ZipCode isNull="true" />
        <City isNull="true" />
      </ProjectAddress>
      <ProjectContactPersonName>helena</ProjectContactPersonName>
      <ProjectContactPersonEmail>helena@test.no</ProjectContactPersonEmail>
      <ProjectContactPersonNumber>11111222</ProjectContactPersonNumber>
      <Reference isNull="true" />
    </Project>
  </MethodParameters>
</ValidateProject>


Note

All fields in the Project model are not returned in the result since it is only used to validate a project. Refer searchProject if you need more details.


Project detailsAddressProjectCompaniesOwnerCompany
  •   ProjectId
  • ProjectAddress
  • Id
  • Id
  •   ProjectName

  • CompanyName
  • CompanyName
  •   ProjectCode

  • OrganizationNumber
  • OrganizationNumber
  •   ProjectType



  •   StartedDate



  •   BoligmappaNumber



  •    IsAdmin




It is inadvisable to use any other fields sent in the result as they may not contain proper values values. 


Exceptions

Error CodeDescription
123An exception occurred while processing your request

138

ApplicationName

applicationName length

is

has exceeded the maximum

allowed

character limit allowed (10)

146The
application name is
applicationName is not set
167You are not authorized to use this method
254Invalid
project code
projectCode
273Project does not exist
277
Project Code
projectCode cannot be empty