GetDocumentsByProject3

Note:

  • This is an performance improved version of the GetDocumentsByProject2.

  • This service will return all the fields similar to GetDocumentsByProject2 except for the DocumentCopiedPropertyDetails. 

  • A new project document model ProjectDocument2 has been introduced without the field DocumentCopiedPropertyDetails.

  • Use this service if DocumentCopiedPropertyDetails field is not required as this service will improve performance.

Description

This method is used to return a list of documents added to a project. All users that belong to a company that is associated with the project can access all the project documents.


Request

Parameter
Type
Mandatory/Optional
Maximum character length/limit
Description
inputGetDocumentsByProjectInputMandatoryNot RelevantGetDocumentsByProject input model
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

GetDocumentsByProjectInput

Parameter
Type
Mandatory/Optional
Description
ProjectIdlongMandatory/OptionalThe Id of the project
ProjectCodestringOptional/MandatoryThe code of the project E.g. ABC0001-A1 


NOTE: It is mandatory to provide either the projectCode or projectId. First preference is always given to the projectId, if both the projectCode and projectId are provided.


Request - sample input

<GetDocumentsByProject3>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <ProjectId>2312</ProjectId>
      <ProjectCode isNull="false" />
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</GetDocumentsByProject3>

Response

TypeDescription
GetDocumentsByProjectOutputGetDocumentsByProjectOutput Model


GetDocumentsByProjectOutput

Parameter
Type
Description
ProjectDocumentsList<ProjectDocument>Project Document Response model list


Response - sample output

<GetDocumentsByProject3>
  <MethodParameters>
    <GetDocumentsByProject3Output>
      <ProjectDocuments attr0="ProjectDocument2Array" isNull="false">
        <ProjectDocument2Array0>
          <DocumentId>59966</DocumentId>
          <FileName>RCA_Sprint 15.docx</FileName>
          <FileTypeId>2</FileTypeId>
          <DocumentTypeId>9</DocumentTypeId>
          <Title>RCA_Sprint 15.docx</Title>
          <Description isNull="true" />
          <OrderNumber isNull="true" />
          <IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>
          <UpdatedDate>6/27/2017 7:09:49 AM</UpdatedDate>
          <Url>https://testbedrift.boligmappa.no:/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=A1FUEEHHUUF%2f%2f1UHgj8Y8oa78Na4XjyLikCyvpfiylup4L0yseUp062Lq2GcgOv8</Url>
          <PdfDocId>59967</PdfDocId>
          <ApplicationTag>Bedrift</ApplicationTag>
          <CompanyId>197</CompanyId>
          <ProfessionId>2</ProfessionId>
          <ProfessionName>VVS/rørlegger</ProfessionName>
          <BuildingId>0</BuildingId>
          <RoomIds isNull="true" />
          <DeviceIds isNull="true" />
          <OrganizationNumber>959069743</OrganizationNumber>
          <UpdatedBy>Sameera</UpdatedBy>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>10</Id>
              <TagName>Annet nyttig</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
          </ChapterTags>
          <Company>
            <Id>197</Id>
            <OrganizationNumber>959069743</OrganizationNumber>
            <CompanyName>CAVERION NORGE AS Avdeling Admninistrasjon</CompanyName>
          </Company>
          <ApartmentTags attr0="ApartmentTagsOutputArray" isNull="false" />
        </ProjectDocument2Array0>
        <ProjectDocument2Array1>
          <DocumentId>59968</DocumentId>
          <FileName>Hi Yohan.docx</FileName>
          <FileTypeId>2</FileTypeId>
          <DocumentTypeId>38</DocumentTypeId>
          <Title>Hi Yohan.docx</Title>
          <Description isNull="true" />
          <OrderNumber isNull="true" />
          <IsVisibleInBoligmappa>True</IsVisibleInBoligmappa>
          <UpdatedDate>6/27/2017 7:09:49 AM</UpdatedDate>
          <Url>https://testbedrift.boligmappa.no:/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=A1FUEEHHUUF%2f%2f1UHgj8Y8h03kIM9ynorRxhDwi904BRz51BNS%2fY04QXi0VUnIBx0</Url>
          <PdfDocId>59969</PdfDocId>
          <ApplicationTag>Bedrift</ApplicationTag>
          <CompanyId>197</CompanyId>
          <ProfessionId>2</ProfessionId>
          <ProfessionName>VVS/rørlegger</ProfessionName>
          <BuildingId>0</BuildingId>
          <RoomIds isNull="true" />
          <DeviceIds isNull="true" />
          <OrganizationNumber>959069743</OrganizationNumber>
          <UpdatedBy>Sameera</UpdatedBy>
          <ChapterTags attr0="ChapterTagOutputArray" isNull="false">
            <ChapterTagOutputArray0>
              <Id>2</Id>
              <TagName>Informasjon om produkter i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray0>
            <ChapterTagOutputArray1>
              <Id>3</Id>
              <TagName>Informasjon om tekniske anlegg i boligen</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray1>
            <ChapterTagOutputArray2>
              <Id>5</Id>
              <TagName>Sjekklister, målinger og kontrollskjema</TagName>
              <TagDescription isNull="true" />
            </ChapterTagOutputArray2>
          </ChapterTags>
          <Company>
            <Id>197</Id>
            <OrganizationNumber>959069743</OrganizationNumber>
            <CompanyName>CAVERION NORGE AS Avdeling Admninistrasjon</CompanyName>
          </Company>
          <ApartmentTags attr0="ApartmentTagsOutputArray" isNull="false" />
        </ProjectDocument2Array1>
      </ProjectDocuments>
    </GetDocumentsByProject3Output>
  </MethodParameters>
</GetDocumentsByProject3>


Exceptions

Error CodeDescription

110

Input parameters contain null or invalid data 

123An exception occurred while processing your request
138 applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
167You are not authorized to use this web method
227The project does not exist or the company is not connected to the given project or your license does not authorize you to access this project
252 

No input is provided for ProjectId or ProjectCode. Provide the input for at least one of these fields 

253 

Ambiguous inputs. Make sure the ProjectCode and projectId refer to the same project 

254 

Invalid ProjectCode