SendDocuments - Obsolete
This method is obsolete and will be completely removed in the near future. Please use the new method, SendDocumentsToPlant - New which provides more metadata.
Description
This method is used to upload multiple documents to Boligmappa. A document is associated with a specific property and a company through the plantId. It can also be tagged with related rooms and devices.
The only difference between this method and SendDocuments is; it allows you to upload multiple documents.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
|---|---|---|---|---|
| plantId | long | Mandatory | Not Relevant | Id of the plant (Building/Property) to where the documents should be uploaded |
documents | List<DocumentInput> | Mandatory | Not Relevant | List of documents to be uploaded |
| propertyOwnerEmail | string | Optional | Not Relevant | A notification is sent to the given email address when a document is uploaded to the property |
| applicationName | string | Mandatory | Less than or equal to 10 characters | The name of the integration partner |
Request - input sample
Notes:
The plantId is mandatory. If the plant does not exist, the method returns an exception (Error code 111). The client is notified to create the plant first, using any of the two methods provided for plant creation.
See:
Response
Once the document is successfully uploaded, a Document Response model list is sent back to the client.
| Type | Description |
|---|---|
| List<DocumentUploadStatus> | Document response model List |
Response - output sample
Exceptions
Error Code | Description |
|---|---|
| 111 | plantId does not exist for your company or your license does not authorize you to access this plantId |
| 112 | There is no document to upload |
| 113 | One or more mandatory fields have not been provided |
| 114 | File name contains invalid charactor(s) |
| 115 | Given ProfessionId(s) are not valid |
| 116 | Invalid DocumentTypeId |
| 123 | An exception occurred while processing your request |
| 126 | File extension is not specified or file extension is not valid |
| 133 | Url or data must be provided to create a document file |
| 138 | applicationName length has exceeded the maximum character limit allowed (10) |
| 146 | The applicationName is not set |
| 165 | The given profession is not registered to your company |
| 167 | You are not authorized to use this web method |
| 179 | One or more of the attached RoomIds does not belong to the given plant |
| 180 | One or more of the attached DeviceIds does not belong to the given plant |
| 181 | For a document to be tagged with a room or a device, the given plant needs to be connected to a property |
| 182 | One or more of the attached BuildingIds does not belong to the given plant |
| 203 | BuildingId of the document should be either 0 or match the building plant provided |
| 217 | An error occurred while sending the notification mail to the user |
| 218 | The propertyOwnerEmail provided is not valid |