BokaMera.API.Host

<back to all web services

DeleteUser

The following routes are available for this service:
DELETE/usersDeletes a userDeletes the logged in user account.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AdminProfile
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Id As Guid
            Public Overridable Property Firstname As String
            Public Overridable Property Lastname As String
            Public Overridable Property Email As String
            Public Overridable Property WorkerId As String
            Public Overridable Property Phone As String
        End Class

        <ApiResponse(Description:="Returned if there is a validation error on the input parameters", StatusCode:=400)>
        <ApiResponse(Description:="Returned if the current user is not allowed to perform the action", StatusCode:=401)>
        Public Partial Class DeleteUser
            '''<Summary>
            '''The user name of your profile.
            '''</Summary>
            <ApiMember(Description:="The user name of your profile.", IsRequired:=true)>
            Public Overridable Property UserName As String

            '''<Summary>
            '''The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
            '''</Summary>
            <ApiMember(Description:="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired:=true)>
            Public Overridable Property Realm As KeyCloakRealm

            '''<Summary>
            '''If this equals true it will force delete all customer profiles on all company on there you have booked a time.
            '''</Summary>
            <ApiMember(Description:="If this equals true it will force delete all customer profiles on all company on there you have booked a time.")>
            Public Overridable Property DeleteCustomerProfiles As Boolean

            '''<Summary>
            '''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.
            '''</Summary>
            <ApiMember(Description:="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.")>
            Public Overridable Property ForceDelete As Boolean

            '''<Summary>
            '''The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.
            '''</Summary>
            <ApiMember(Description:="The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.")>
            Public Overridable Property Token As String
        End Class

        Public Partial Class DeleteUserResponse
            Public Overridable Property ResponseStatus As Object
            '''<Summary>
            '''The user id for your profile.
            '''</Summary>
            <ApiMember(Description:="The user id for your profile.", IsRequired:=true)>
            Public Overridable Property UserName As String

            Public Overridable Property UserProfile As UserProfileResponse
            Public Overridable Property AdminProfile As AdminProfile
        End Class

        Public Partial Class UserProfileResponse
            Public Overridable Property Id As Guid
            Public Overridable Property Firstname As String
            Public Overridable Property Lastname As String
            Public Overridable Property Phone As String
            Public Overridable Property Email As String
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum KeyCloakRealm
            BookMore = 1
            BookMoreAdmin = 2
            SuperAdmin = 3
        End Enum
    End Namespace
End Namespace

VB.NET DeleteUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{},"UserName":"String","UserProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"AdminProfile":{"Firstname":"String","Lastname":"String","Email":"String","WorkerId":"String","Phone":"String"}}