RemoveUser
Overview
Deletes a single User that is already in the system. Returns Success/Error code.
Request Information
Method
POST - api/Person/RemoveUser
URI Parameters
None.
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. |
JSON
{
"UserId": "b35d0e48-9de9-4a3e-b570-4bc6040a43ce",
"RemovalDateTime": "2016-12-13T23:32:19.0619349-05:00"
}
XML
<RemoveUserViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
<RemovalDateTime>2016-12-13T23:32:19.0619349-05:00</RemovalDateTime>
<UserId>b35d0e48-9de9-4a3e-b570-4bc6040a43ce</UserId>
</RemoveUserViewModel>
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
JSON
{
"ResultCode": 1,
"Description": "sample string 2"
}
XML
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BluSKYWebAPI.Controllers">
`````<Description>``````sample string 2</Description>
`<ResultCode>`1</ResultCode>
</Result>