Description
This method can be used to create ApartmentTags for a given project. And it returns the created ApartmentTags as the output.
Notes:
- Multiple ApartmentTags can be added at the same time.
- Only the project owner company can add ApartmentTags for that project.
Request
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| input | AddApartmentTagsToProjectInput | Mandatory | AddApartmentTagsToProjectInput model |
| applicationName | String | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the applicationName should be less than or equal to 10) |
AddApartmentTagsToProjectInput
Parameter | Type | Mandatory/Optional | Comments |
|---|---|---|---|
| ProjectId | long | Mandatory/Optional* | The Id of the project. |
| ProjectCode | string | Mandatory/Optional* | Project code of the project E.g. ABC0001-A1 |
| ApartmentTag | List<ApartmentTagstInput> | Mandatory | List of ApartmentTags to be added to the given project. ApartmentTag (ApartmentTag Name) is a mandatory field for this method |
Note
- Need to provide at least one of these fields (ProjectId, ProjectCode)
- ProjectId will be the first preference
Response
Type | Description |
|---|---|
| AddApartmentTagsToProjectOutput | AddApartmentTagsToProjectOutput model |
AddApartmentTagsToProjectOutput
Parameter | Type | Comments |
|---|---|---|
| Statuses | List<AddApartmentTagsToProjectStatus> | Project ApartmentTag creation statuses list |
Exceptions
Error Code | Description |
|---|---|
| 110 | Input parameters contain null or invalid data |
| 123 | An exception occured while processing your request |
| 138 | ApplicationName length is exceeded maximum allowed character limit (10) |
| 146 | The application name is not set |
| 167 | You are not authorized to use this web method |
| 223 | The given project is not owned by the company or does not exist, therefore this action cannot be performed |
| 252 | No input is provided to project Id or project code. Need atleast one of them |
| 254 | Invalid project code |
| 273 | Project does not exist |
| 299 | The given project is closed. |
| 322 | ApartmentTag already exists |
| 323 | No ApartmentTags are provided |
| 324 | ApartmentTag name is not provided |
| 325 | ApartmentTag Name has exceeded maximum length (50) |