DeleteApartmentTags

Description

This method is used to remove one or more apartment tags from the project. It can only be used by project owners. 

 

Request

Parameter
Type
Mandatory/Optional
Maximum character length/limit
Description
inputDeleteApartmentTagsInputMandatoryNot relevantDeleteApartmentTagsInput model
applicationNamestringMandatoryShould be less than or equal to 10 charactersThe name of the integration partner

 

DeleteApartmentTagsInput

Parameter
Type
Mandatory/Optional
Description
ApartmentTagsToBeDeletedList<ApartmentTagsToDelete>MandatoryList of apartment tags to be deleted


Request - sample input

<DeleteApartmentTags>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <ApartmentTagsToBeDeleted attr0="ApartmentTagsToDeleteArray" isNull="false">
        <ApartmentTagsToDeleteArray0>
          <ApartmentTagId>1</ApartmentTagId>
        </ApartmentTagsToDeleteArray0>
      </ApartmentTagsToBeDeleted>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</DeleteApartmentTags> 

Response

Type
Description
DeleteApartmentTagsOutputDeleteApartmentTagsOutput model

 

SendDocumentsToPlantOutput

Parameter
Type
Description
StatusesList<DeleteApartmentTagStatus>Delete Apartment tag response status


Response - sample output

<DeleteApartmentTags>
  <MethodParameters>
    <DeleteApartmentTagsOutput>
      <Statuses attr0="DeleteApartmentTagStatusArray" isNull="false">
        <DeleteApartmentTagStatusArray0>
          <Status>True</Status>
          <ApartmentTagId>1</ApartmentTagId>
          <ApartmentTagName>dd</ApartmentTagName>
          <ErrorCode>0</ErrorCode>
        </DeleteApartmentTagStatusArray0>
      </Statuses>
    </DeleteApartmentTagsOutput>
  </MethodParameters>


Exceptions

Error Code
Description
110Input parameters contain null or invalid data
123An exception occurred while processing your request
138 applicationName length has exceeded the maximum character limit allowed (10) 
146The applicationName is not set
167You are not authorized to use this method
273Project does not exist
316This action cannot be performed on a closed project
326This action cannot be performed since documents are associated with this ApartmentTag
327Company is not authorized to delete this ApartmentTag
328ApartmentTagId does not exist