| 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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /users HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus: {},
UserName: String,
UserProfile:
{
Firstname: String,
Lastname: String,
Phone: String,
Email: String,
InvoiceAddress:
{
UserId: 00000000-0000-0000-0000-000000000000,
CorporateIdentityNumber: String,
InvoiceAddress1: String,
InvoiceAddress2: String,
InvoiceCity: String,
InvoicePostalCode: String,
InvoiceCountryCode: String
}
},
AdminProfile:
{
Firstname: String,
Lastname: String,
Email: String,
WorkerId: String,
Phone: String
}
}