EditApartmentTag

This method is used to Edit an apartment tags from the project. It can only be used by project owners.

Request

Parameter

Type

Mandatory/ Optional

Maximum character length/limit

Description

Parameter

Type

Mandatory/ Optional

Maximum character length/limit

Description

input

EditApartmentTagInput

Mandatory

Not relevant

EditApartmentTagInput model

applicationName

string

Mandatory

Should be less than or equal to 10 characters

The name of the integration partner

EditApartmentTagInput

Parameter

Type

Mandatory/Optional

Description

Parameter

Type

Mandatory/Optional

Description

ApartmentId

int

Mandatory

Apartment ID of the selected apartment tag.

ApartmentTagName

string

Mandatory

Apartment Name of the selected apartment tag.

Request - sample input

<EditApartmentTag> <input> <ApartmentId>int</ApartmentId> <ApartmentTagName>string</ApartmentTagName> </input> <applicationName>string</applicationName> </EditApartmentTag>

Response

Type

Description

Type

Description

EditApartmentTagOutput

EditApartmentTagOutput model

 

EditApartmentTagOutput

Parameter

Type

Description

Parameter

Type

Description

Status

bool

Edit Apartment tag response status

ErrorCode

int

Error code number

Response - sample output

<EditApartmentTagResponse> <EditApartmentTagResult> <Status>boolean</Status> <ErrorCode>int</ErrorCode> </EditApartmentTagResult> </EditApartmentTagResponse>

 

Exceptions

Error Code

Description

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

316

This action cannot be performed on a closed project

322

ApartmentTag already exists

325

ApartmentTag name length has exceeded the maximum character limit allowed (50)

328

ApartmentTagId does not exist

429

Company is not authorized to edit this ApartmentTag