Description
This Web method Generates is used to generate a summary document of all the documents copied documents from a given project to a given property/building. This web method is accessible only accessible for project owners.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
---|---|---|---|---|
input | GenerateProjectSummaryDocumentInputGenerateProjectSummaryDocumentInput | Mandatory | Not Relevant | GenerateProjectSummaryDocumentInput model |
applicationName | string | Mandatory | Third party application identifier, identifying the client consuming the web service. (Length of the ApplicationName |
Note: Always provide only one parameter out of ProjectId and ProjectCode in GenerateProjectSummaryDocumentInput. However, if both ProjectId and ProjectCode are provided, priority is given to the ProjectId.
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
Response
Type | Description |
---|---|
GenerateProjectSummaryDocumentOutput | GenerateProjectSummaryDocumentOutput model |
GenerateProjectSummaryDocumentOutput
Parameter | Type | Comments |
---|---|---|
SummaryDocument | string | Download URL of generated summary document |
Response - sample output
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 project code ProjectCode |
377 | You are not authorized to perform this operation |
393 | No Documents Copied From this Project documents were copied from this project to this Propertyproperty |