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.
import Foundation
import ServiceStack

// @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 class DeleteUser : Codable
{
    /**
    * The user name of your profile.
    */
    // @ApiMember(Description="The user name of your profile.", IsRequired=true)
    public var userName:String

    /**
    * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    */
    // @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    public var realm:KeyCloakRealm

    /**
    * If this equals true it will force delete all customer profiles on all company on there you have booked a time.
    */
    // @ApiMember(Description="If this equals true it will force delete all customer profiles on all company on there you have booked a time.")
    public var deleteCustomerProfiles:Bool

    /**
    * 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.
    */
    // @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 var forceDelete:Bool

    /**
    * The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.
    */
    // @ApiMember(Description="The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.")
    public var token:String

    required public init(){}
}

public enum KeyCloakRealm : Int, Codable
{
    case BookMore = 1
    case BookMoreAdmin = 2
    case SuperAdmin = 3
}

public class DeleteUserResponse : Codable
{
    //responseStatus:Object ignored. Type could not be extended in Swift
    /**
    * The user id for your profile.
    */
    // @ApiMember(Description="The user id for your profile.", IsRequired=true)
    public var userName:String

    public var userProfile:UserProfileResponse
    public var adminProfile:AdminProfile

    required public init(){}
}

public class UserProfileResponse : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String

    required public init(){}
}

public class AdminProfile : Codable
{
    public var companyId:String
    public var id:String
    public var firstname:String
    public var lastname:String
    public var email:String
    public var workerId:String
    public var phone:String

    required public init(){}
}


Swift DeleteUser DTOs

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

HTTP + 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: testapi.bokamera.se 
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>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</DeleteUserResponse>