| DELETE | /users | Deletes a user | Deletes the logged in user account. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | query | string | Yes | The user name of your profile. |
| Realm | query | KeyCloakRealm | Yes | The user realm for identity server. BookMore = 1, BookMoreAdmin = 2 |
| DeleteCustomerProfiles | query | bool | No | If this equals true it will force delete all customer profiles on all company on there you have booked a time. |
| ForceDelete | query | bool | No | If this equals true it will check the request token value and try to delete user, if it is false it will send a delete confirmation email. |
| Token | query | string | Yes | The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email. |
| Name | Value | |
|---|---|---|
| BookMore | 1 | |
| BookMoreAdmin | 2 | |
| SuperAdmin | 3 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | Object | Yes | |
| UserName | form | string | Yes | The user id for your profile. |
| UserProfile | form | UserProfileResponse | Yes | |
| AdminProfile | form | AdminProfile | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Firstname | form | string | Yes | |
| Lastname | form | string | Yes | |
| Phone | form | string | Yes | |
| form | string | Yes | ||
| InvoiceAddress | form | InvoiceAddressResponse | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceAddressId | form | Guid | No | |
| UserId | form | Guid? | No | |
| CorporateIdentityNumber | form | string | Yes | |
| InvoiceAddress1 | form | string | Yes | |
| InvoiceAddress2 | form | string | Yes | |
| InvoiceCity | form | string | Yes | |
| InvoicePostalCode | form | string | Yes | |
| InvoiceCountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | No | |
| Id | form | Guid | No | |
| Firstname | form | string | Yes | |
| Lastname | form | string | Yes | |
| form | string | Yes | ||
| WorkerId | form | string | Yes | |
| Phone | form | string | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /users HTTP/1.1 Host: api.bookmore.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DeleteUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AdminProfile>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Email>String</Email>
<Firstname>String</Firstname>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Lastname>String</Lastname>
<Phone>String</Phone>
<WorkerId>String</WorkerId>
</AdminProfile>
<ResponseStatus />
<UserName>String</UserName>
<UserProfile>
<Email>String</Email>
<Firstname>String</Firstname>
<Id>00000000-0000-0000-0000-000000000000</Id>
<InvoiceAddress>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
</InvoiceAddress>
<Lastname>String</Lastname>
<Phone>String</Phone>
</UserProfile>
</DeleteUserResponse>