AddApartmentTagsToProject

Description

This method is used to create ApartmentTags for a given project. The created ApartmentTags are returned as the output.

Notes

Multiple ApartmentTags can be added at the same time.
Only the project owner of the company can add ApartmentTags to that project.

Request

Parameter	Type	Mandatory/Optional	Maximum character length/limit	Description
input	AddApartmentTagsToProjectInput	Mandatory	Not Relevant	AddApartmentTagsToProjectInput model
applicationName	String	Mandatory	Should be less than or equal to 10 characters	The name of the integration partner

AddApartmentTagsToProjectInput

Parameter	Type	Mandatory/Optional	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 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	Description
Statuses	List<AddApartmentTagsToProjectStatus>	Project ApartmentTag creation statuses list

Response - sample output

Exceptions

Error Code	Description
110	Input parameters contain null or invalid data
123	An exception occured 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
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 for projectId or projectCode. Provide the input for at least one of these fields
254	Invalid projectCode
273	Project does not exist
299	The given project is closed
322	ApartmentTag already exists
323	ApartmentTags are not provided
324	ApartmentTag name is not provided
325	ApartmentTag name length has exceeded the maximum character limit allowed (50)