DELETE api/v2/Users/{id}
Deletes a single User that is already in the system. Returns Success/Error code
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
User Id |
globally unique identifier |
Required |
Body Parameters
RemoveUserViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Required: The PK of the existing User that you want to remove. |
globally unique identifier |
None. |
| RemovalDateTime |
Optional: If null, User will be marked as deleted immediately. If populated, User will not be marked as deleted, but will have their EndDateTime set to this value. |
date |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserId": "383874c4-c1da-412a-a64e-d4dd112a387c",
"RemovalDateTime": "2025-10-11T05:24:37.108879+00:00"
}
application/xml, text/xml
Sample:
<RemoveUserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <RemovalDateTime>2025-10-11T05:24:37.108879+00:00</RemovalDateTime> <UserId>383874c4-c1da-412a-a64e-d4dd112a387c</UserId> </RemoveUserViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultCode |
Represents the result code |
integer |
None. |
| Description |
Represents a description of the result code |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResultCode": 1,
"Description": "sample string 2"
}
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIWebRole.Controllers"> <Description>sample string 2</Description> <HttpStatusCode>Continue</HttpStatusCode> <ResultCode>1</ResultCode> </Result>