POST api/UserAccount/Deactivate/{username}

Deactivates a user

Request Information

URI Parameters

NameDescriptionTypeMandatory when
username

string

Always Required

Body Parameters

None.

Response Information

Resource Description

JsonResponseModelOfString
NameDescriptionTypeMandatory when
ResponseCode

integer

ResponseMessage

string

Data

string

Response Formats

application/json, text/json

Sample: 
{
  "ResponseCode": 200,
  "ResponseMessage": "User deactivated.",
  "Data": "test@example.com"
}

text/xml

Sample: 
<JsonResponseModelOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RGS.API.Models">
  <Data>test@example.com</Data>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>User deactivated.</ResponseMessage>
</JsonResponseModelOfstring>

Error Response Causes

  • Invalid API credentials
  • No user exists with the given username