DeleteUser

Description

This method is used to delete the list of users that were provided and returns the DeleteUserStatus list as the output. This web method can be accessed by company admin users only. If admin user tries to delete his own account while he is the only admin in the company, he will not be able to delete the account

Request

ParameterTypeMandatory/OptionalMaximum character LimitationDescription
inputDeleteUserInputMandatoryNoneDelete user input model

applicationName

string

Mandatory

Should be less than or equal to 10 characters

The name of the integration partner

Sample Request

<DeleteUsers>
  <MethodParameters>
    <UserAuthentication>
      <UserName>username</UserName>
      <Password>password</Password>
      <AnyAttr attr0="XmlAttributeArray" isNull="false">
        <XmlAttributeArray0>System.Xml.XmlAttribute</XmlAttributeArray0>
      </AnyAttr>
    </UserAuthentication>
    <input>
      <Users attr0="StringArray" isNull="false">
        <StringArray0>user1</StringArray0>
        <StringArray1>user2</StringArray1>
      </Users>
    </input>
    <applicationName>test</applicationName>
  </MethodParameters>
</DeleteUsers>

Response

TypeDescription
DeleteUserOutputDelete user output model


Sample Response

<DeleteUsers>
  <MethodParameters>
    <DeleteUserOutput>
      <DeleteStatus attr0="DeleteUserStatusArray" isNull="false">
        <DeleteUserStatusArray0>
          <UserName>user1</UserName>
          <IsDeleted>True</IsDeleted>
          <ErrorCode>0</ErrorCode>
        </DeleteUserStatusArray0>
        <DeleteUserStatusArray1>
          <UserName>user2</UserName>
          <IsDeleted>True</IsDeleted>
          <ErrorCode>0</ErrorCode>
        </DeleteUserStatusArray1>
      </DeleteStatus>
    </DeleteUserOutput>
  </MethodParameters>
</DeleteUsers>

Exceptions

Error CodeDescription
110Input parameters contain null or invalid data

123

An exception occurred while processing your request

138applicationName length has exceeded the maximum character limit allowed (10)
146The applicationName is not set
167You are not authorized to use this method 
366The given UserName does not exist
371Given user does not exist in your company
407You are trying to delete the only available Admin account for your company. Please create another Admin account first and Try again or please contact Boligmappa Support
408An error occured while deleting the user
409User is already Deleted