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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserProfileResponse:
    id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminProfile:
    company_id: Optional[str] = None
    id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    email: Optional[str] = None
    worker_id: Optional[str] = None
    phone: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteUserResponse:
    response_status: Optional[Object] = None
    # @ApiMember(Description="The user id for your profile.", IsRequired=true)
    user_name: Optional[str] = None
    """
    The user id for your profile.
    """


    user_profile: Optional[UserProfileResponse] = None
    admin_profile: Optional[AdminProfile] = None


class KeyCloakRealm(IntEnum):
    BOOK_MORE = 1
    BOOK_MORE_ADMIN = 2
    SUPER_ADMIN = 3


# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteUser:
    # @ApiMember(Description="The user name of your profile.", IsRequired=true)
    user_name: Optional[str] = None
    """
    The user name of your profile.
    """


    # @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    realm: Optional[KeyCloakRealm] = None
    """
    The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    """


    # @ApiMember(Description="If this equals true it will force delete all customer profiles on all company on there you have booked a time.")
    delete_customer_profiles: bool = False
    """
    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 check the request token value and try to delete user, if it is false it will send a delete confirmation email.")
    force_delete: bool = False
    """
    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="The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.")
    token: Optional[str] = None
    """
    The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.
    """

Python 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: api.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>