NoteNOTE:
This method is deprecated obsolete and will be completely removed completely in the near future. Hence it is advised to Please use the new web service methodnew method, SendDocumentsToProject2 which provides more meta data.
Description
SendDocumentsToProject web This method is used for submitting to submit document(s) to Projectsprojects. Once a company is added to a project, all users of that company can send documents to the project using this method. The uploaded documents will be are shared with all the companies that are connected to the project but with limited access. (User A user does not have edit/delete aceess access to the documents uploaded by other companies. However the full complete access will be is given to to any user within the for documents uploaded by their company. Apart from that Only the project owner of a company has access is allowed to copy documents to propertlyproperty/bulding building plants.)
It is possible to tag documents with related devices, rooms, buildings and buildingschapters.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
---|---|---|---|---|
documents | List<DocumentInput> | Mandatory | Not relevant | List of documents to be sent to the project |
projectId | long | Mandatory/Optional | Not relevant | Id of the project |
projectCode | string | Optional/MandatoryMandatory/Optional | Not relevant | Project code of the project E.g. ABC0001-A1 |
applicationName | string | Mandatory | Unique identifier (of your choice) to identify the client application which consumes the Boligmappa API. (length Should be less than or equal to 10 characters) | The name of the integration partner |
Note :
Need to provide at least one of these fields (project Id, project code)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 |
---|---|
List<DocumentUploadStatus> | Document response Response model Listlist |
Response - sample output
Exceptions
Error Code | Description |
---|---|
112 | There is no document to upload |
113 | One or more mandatory fields have not been supplied as inputprovided |
114 | File name contains invalid charactor(s) |
115 | Given professionIdProfessionId(s) are not valid |
116 | Invalid document type IDInvalid 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 |
136 | Invalid document Provided Url is invalid |
138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
146 | The application name applicationName is not set |
165 | The given profession is not registered to your company |
167 | You are not authorized to use this web method |
227 | The project does not exist or the company is not connected to the given project |
235 | One of more of the attached building Ids BuildingIds does not belong to the property attached to the given project |
252 | No input is provided to project Id or project code. Need atleast one of them for projectId or projectCode. Provide the input for at least one of these fields |
253 | Ambiguous inputs. Make sure projet code and project id referred the projectCode and projectId refer to the same project |
254 | Invalid project code projectCode |
317 | One or more of the attached room Ids RoomIds does not belong to the project |
318 | Attached device Id is not belongs DeviceId does not belong to the project |