Description
...
Description
This method is used to create ApartmentTags for a given project. And it returns the The created ApartmentTags partmentTags are returned as the output.
Notes:
- Multiple ApartmentTags can be added at the same time.
- Only the project project owner of the company can add ApartmentTags for to that project.
Request
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| input | AddApartmentTagsToProjectInput | Mandatory | Not Relevant | AddApartmentTagsToProjectInput model |
| applicationName | String | Mandatory | Third party application identifier, identifying the client consuming the web service – (Length of the applicationName should Should be less than or equal to 10 ) characters | The name of the integration partner |
AddApartmentTagsToProjectInput
Parameter | Type | Mandatory/OptionalComments | Maximum character length/limit | Description |
|---|---|---|---|---|
| ProjectId | long | Mandatory/Optional* | Not Relevant | The Id of the project. |
| ProjectCode | string | Mandatory/Optional* | Should be less than or equal to 25 characters | Project code of the project E.g. ABC0001-A1 |
| ApartmentTag | List<ApartmentTagstInput> | Mandatory | Should be less than or equal to 50 characters | List of ApartmentTags to be added to the a given project. ApartmentTag (ApartmentTag Name) is a mandatory field for this method |
Note
...
It is mandatory to provide either the projectCode or the projectId. Preference is given to the projectId, if both the projectCode and the projectId are provided.
Request - sample input
<AddApartmentTagsToProject>
<MethodParameters>
<UserAuthentication>
<UserName>username</UserName>
<Password>password</Password>
<AnyAttr attr0="XmlAttributeArray" isNull="false">
<XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
</AnyAttr>
</UserAuthentication>
<input>
<ProjectId>1207</ProjectId>
<ProjectCode isNull="false" />
<ApartmentTags attr0="ApartmentTagstInputArray" isNull="false">
<ApartmentTagstInputArray0>
<ApartmentTag>Tag1</ApartmentTag>
</ApartmentTagstInputArray0>
</ApartmentTags>
</input>
<applicationName>test</applicationName>
</MethodParameters>
</AddApartmentTagsToProject>
Response
Type | Description |
|---|---|
| AddApartmentTagsToProjectOutput | AddApartmentTagsToProjectOutput model |
...
AddApartmentTagsToProjectOutput
Parameter | Type | CommentsDescription |
|---|---|---|
| Statuses | List<AddApartmentTagsToProjectStatus> | Project ApartmentTag creation statuses list |
Response - sample output
<AddApartmentTagsToProject>
<MethodParameters>
<AddApartmentTagsToProjectOutput>
<Statuses attr0="AddApartmentTagsToProjectStatusArray" isNull="false">
<AddApartmentTagsToProjectStatusArray0>
<Status>1</Status>
<ApartmentTag>
<Id>112</Id>
<ProjectId>1207</ProjectId>
<ApartmentTag>Tag1</ApartmentTag>
</ApartmentTag>
<ErrorCode>0</ErrorCode>
</AddApartmentTagsToProjectStatusArray0>
</Statuses>
</AddApartmentTagsToProjectOutput>
</MethodParameters>
</AddApartmentTagsToProject>
Exceptions
Error Code | Description |
|---|---|
| 110 | Input parameters contain null or invalid data |
| 123 | An exception occured while processing your request |
| 138 | ApplicationName applicationName length is has exceeded the maximum allowed character limit allowed (10) |
| 146 | The application name applicationName is not set 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 for projectId or projectCode. Provide the input for at least one of these fields |
| 254 | Invalid project code projectCode |
| 273 | Project does not exist |
| 299 | The given project is closed. |
| 322 | ApartmentTag already exists |
| 323 | No ApartmentTags are not provided |
| 324 | ApartmentTag name is not provided |
| 325 | ApartmentTag Name name length has exceeded the maximum length character limit allowed (50) |