BokaMera.API.Host

SuperAdminDeleteCompanyUser

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
DELETE	/superadmin/administrators/{Id}	Delete a administrator from your company	If you want to delete a administrator from your company.

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 CompanyUserResource:
    # @ApiMember(Description="The resource id")
    id: int = 0
    """
    The resource id
    """


    # @ApiMember(Description="The resource name")
    name: Optional[str] = None
    """
    The resource name
    """


    # @ApiMember(Description="The resource status")
    active: bool = False
    """
    The resource status
    """


    # @ApiMember(Description="The resource description")
    description: Optional[str] = None
    """
    The resource description
    """


    # @ApiMember(Description="The resource email")
    email: Optional[str] = None
    """
    The resource email
    """


    # @ApiMember(Description="The resource phone")
    phone: Optional[str] = None
    """
    The resource phone
    """


    # @ApiMember(Description="The resource color")
    color: Optional[str] = None
    """
    The resource color
    """


    # @ApiMember(Description="The resource image")
    image_url: Optional[str] = None
    """
    The resource image
    """


    # @ApiMember(Description="If the resource want to receive email notifications")
    email_notification: bool = False
    """
    If the resource want to receive email notifications
    """


    # @ApiMember(Description="If the resource want to receive sms notifications")
    sms_notification: bool = False
    """
    If the resource want to receive sms notifications
    """


    # @ApiMember(Description="If the resource want to receive email reminders")
    email_reminder: bool = False
    """
    If the resource want to receive email reminders
    """


    # @ApiMember(Description="If the resource want to receive sms reminders")
    sms_reminder: bool = False
    """
    If the resource want to receive sms reminders
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyUserRolesQueryResponse:
    role_id: Optional[str] = None
    name: Optional[str] = None
    description: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyUserQueryResponse:
    id: Optional[str] = None
    company_id: Optional[str] = None
    firstname: Optional[str] = None
    lastname: Optional[str] = None
    email: Optional[str] = None
    phone: Optional[str] = None
    worker_id: Optional[str] = None
    resource_id: Optional[int] = None
    # @ApiMember(Description="The resource information connected to the administrator.")
    resource: Optional[CompanyUserResource] = None
    """
    The resource information connected to the administrator.
    """


    # @ApiMember(Description="The roles that are connected to the administrator.")
    roles: Optional[List[CompanyUserRolesQueryResponse]] = None
    """
    The roles that are connected to the administrator.
    """


    active: bool = False
    created: datetime.datetime = datetime.datetime(1, 1, 1)
    updated: datetime.datetime = datetime.datetime(1, 1, 1)


# @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 SuperAdminDeleteCompanyUser(ICompany):
    # @ApiMember(Description="Enter the company and id for the application user, if blank company id and you are an admin, your company id will be used.", ParameterType="query")
    company_id: Optional[str] = None
    """
    Enter the company and id for the application user, if blank company id and you are an admin, your company id will be used.
    """


    # @ApiMember(Description="Enter the user id for the administrator.", IsRequired=true, ParameterType="query")
    id: Optional[str] = None
    """
    Enter the user id for the administrator.
    """

Python SuperAdminDeleteCompanyUser DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /superadmin/administrators/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","WorkerId":"String","ResourceId":0,"Resource":{"Id":0,"Name":"String","Active":false,"Description":"String","Email":"String","Phone":"String","Color":"String","EmailNotification":false,"SMSNotification":false,"EmailReminder":false,"SMSReminder":false},"Roles":[{"Name":"String","Description":"String"}],"Active":false}