GetApartmentTagsForProject
Description
This method is used to return a list of ApartmentTags added to a project. Users that belong to a company associated with the project can access all the ApartmentTags.
Request
Parameter | Type | Mandatory/Optional | Maximum character length/limit | Description |
---|---|---|---|---|
input | GetApartmentTagsForProjectInput | Mandatory | Not relevant | GetApartmentTagsForProject input model |
applicationName | string | Mandatory | Should be less than or equal to 10 characters | The name of the integration partner |
GetApartmentTagsForProjectInput
Parameter | Type | Mandatory/Optional | Description |
---|---|---|---|
ProjectId | long | Mandatory/Optional | The project Id of the project |
ProjectCode | string | Optional/Mandatory | Project code of the project E.g. ABC0001-A1 |
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
<GetApartmentTagsForProject>
<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" />
</input>
<applicationName>test</applicationName>
</MethodParameters>
</GetApartmentTagsForProject>
Response
Type | Description |
---|---|
GetApartmentTagsForProjectOutput | GetApartmentTagsForProjectOutput model |
GetApartmentTagsForProjectOutput
Parameter | Type | Description |
---|---|---|
ApartmentTags | List<ApartmentTagsOutput> | ApartmentTags response model list |
Request - sample output
<GetApartmentTagsForProject>
<MethodParameters>
<GetApartmentTagsForProjectOutput>
<ApartmentTags attr0="ApartmentTagsOutputArray" isNull="false">
<ApartmentTagsOutputArray0>
<ApartmentTagId>113</ApartmentTagId>
<ApartmentTagName>2</ApartmentTagName>
<ApartmentTagStatus>1</ApartmentTagStatus>
</ApartmentTagsOutputArray0>
<ApartmentTagsOutputArray1>
<ApartmentTagId>112</ApartmentTagId>
<ApartmentTagName>Tag1</ApartmentTagName>
<ApartmentTagStatus>1</ApartmentTagStatus>
</ApartmentTagsOutputArray1>
</ApartmentTags>
</GetApartmentTagsForProjectOutput>
</MethodParameters>
</GetApartmentTagsForProject>
Exceptions
Error Code | Description |
---|---|
110 | Input parameters contain null or invalid data |
123 | An exception occurred while processing your request |
138 | applicationName length has exceeded the maximum character limit allowed (10) |
146 | The applicationName is not set |
167 | You are not authorized to use this method |
227 | The project does not exist or the company is not connected to the given project |
252 | No input is provided for projectId or projectCode. Provide the input for at least one of these fields |
254 | Invalid projectCode |
273 | Project does not exist |