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

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
input	GenerateProjectSummaryDocumentInput	Mandatory	Not relevant	GenerateProjectSummaryDocumentInput model
applicationName	string	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

GenerateProjectSummaryDocumentInput

Property	Type	Mandatory/Optional	Description
ProjectId	long	Mandatory / Optional	The Id of the project
ProjectCode	string	Mandatory / Optional	The code of the project E.g. ABC0001-A1
BoligmappaNumber	string	Mandatory	Boligmappa 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

Type	Description
GenerateProjectSummaryDocumentOutput	GenerateProjectSummaryDocumentOutput model

GenerateProjectSummaryDocumentOutput

Parameter	Type	Description
SummaryDocument	string	Download URL of generated summary document
DocumentId	long	Document 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 Code	Description
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
214	The given property does not exists in the system
227	The project does not exist or the company is not connected to the given project
254	Invalid ProjectCode
377	You are not authorized to perform this operation
393	No documents were copied from this project to this property