DELETE api/account/{username}
V1 - Remove user from the database. Any existing data is maintained where possible, by linking it to an anonymous user. Only users linked to the current Vendor can be deleted. A 404 will be generated if the user is not found. A 403 will be generated if a user cannot be removed.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| username | string |
Required |
Body Parameters
None.
Response Information
Resource Description
RemovalResult| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID |
The removed UserID. |
string |
None. |
|
The removed email address. |
string |
Data type: EmailAddress |
|
| Username |
The removed username. |
string |
Data type: Text |
| Status |
YindoApiStatus defines statuscodes. |
YindoApiStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"UserID": "sample string 1",
"Email": "sample string 2",
"Username": "sample string 3",
"Status": {
"Code": 0,
"Text": "sample string 1"
}
}
text/javascript
Sample:
{"UserID":"sample string 1","Email":"sample string 2","Username":"sample string 3","Status":{"Code":0,"Text":"sample string 1"}}
application/xml, text/xml
Sample:
<RemovalResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VersionedVendorApi.Models">
<Status xmlns="http://schemas.datacontract.org/2004/07/Yindo.BLL.API">
<Code>Success</Code>
<Text>sample string 1</Text>
</Status>
<Email>sample string 2</Email>
<UserID>sample string 1</UserID>
<Username>sample string 3</Username>
</RemovalResult>