GenerateProjectSummaryDocument

Description

This method is used to generate a summary document of all the documents copied from a given project to a given property/building. This method is only accessible for project owners.

Request

ParameterTypeMandatory/OptionalMaximum character length/limitDescription
inputGenerateProjectSummaryDocumentInput MandatoryNot relevantGenerateProjectSummaryDocumentInput model
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner


GenerateProjectSummaryDocumentInput

PropertyTypeMandatory/OptionalDescription
ProjectIdlongMandatory / OptionalThe Id of the project
ProjectCodestringMandatory / OptionalThe code of the project E.g. ABC0001-A1 
BoligmappaNumberstringMandatoryBoligmappa Number of the property

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

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

Response

TypeDescription
GenerateProjectSummaryDocumentOutputGenerateProjectSummaryDocumentOutput model


GenerateProjectSummaryDocumentOutput

Parameter

Type

Description

SummaryDocumentstringDownload URL of generated summary document
DocumentIdlongDocument Id for the document

Response - sample output

<GenerateProjectSummaryDocument>
  <MethodParameters>
    <GenerateProjectSummaryDocumentOutput>
      <SummaryDocument>http://172.20.1.183:8080/Document/DownloadDocumentWebService/DownloadDocWithSessionKey?sessionKey=rl%2fL3WDK6Fs%2bCIaABAaVXxjiAeF2nW3jNyjdlA1Pb9n27aesnNnPGVQvqH7f45Cb</SummaryDocument>
      <DocumentId>2100</DocumentId>
    </GenerateProjectSummaryDocumentOutput>
  </MethodParameters>
</GenerateProjectSummaryDocument>

Exceptions

Error CodeDescription

110

Input parameters contain null or invalid data

113

One or more mandatory fields have not been provided 

123

An exception occurred while processing your request

214The given property does not exists in the system
227The project does not exist or the company is not connected to the given project
254 

Invalid ProjectCode 

377You are not authorized to perform this operation
393No documents were copied from this project to this property