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.


export class CompanyUserResource
{
    /** @description The resource id */
    // @ApiMember(Description="The resource id")
    public Id: number;

    /** @description The resource name */
    // @ApiMember(Description="The resource name")
    public Name: string;

    /** @description The resource status */
    // @ApiMember(Description="The resource status")
    public Active: boolean;

    /** @description The resource description */
    // @ApiMember(Description="The resource description")
    public Description: string;

    /** @description The resource email */
    // @ApiMember(Description="The resource email")
    public Email: string;

    /** @description The resource phone */
    // @ApiMember(Description="The resource phone")
    public Phone: string;

    /** @description The resource color */
    // @ApiMember(Description="The resource color")
    public Color: string;

    /** @description The resource image */
    // @ApiMember(Description="The resource image")
    public ImageUrl: string;

    /** @description If the resource want to receive email notifications */
    // @ApiMember(Description="If the resource want to receive email notifications")
    public EmailNotification: boolean;

    /** @description If the resource want to receive sms notifications */
    // @ApiMember(Description="If the resource want to receive sms notifications")
    public SMSNotification: boolean;

    /** @description If the resource want to receive email reminders */
    // @ApiMember(Description="If the resource want to receive email reminders")
    public EmailReminder: boolean;

    /** @description If the resource want to receive sms reminders */
    // @ApiMember(Description="If the resource want to receive sms reminders")
    public SMSReminder: boolean;

    public constructor(init?: Partial<CompanyUserResource>) { (Object as any).assign(this, init); }
}

export class CompanyUserRolesQueryResponse
{
    public RoleId: string;
    public Name: string;
    public Description: string;

    public constructor(init?: Partial<CompanyUserRolesQueryResponse>) { (Object as any).assign(this, init); }
}

export class CompanyUserQueryResponse
{
    public Id: string;
    public CompanyId: string;
    public Firstname: string;
    public Lastname: string;
    public Email: string;
    public Phone: string;
    public WorkerId: string;
    public ResourceId?: number;
    /** @description The resource information connected to the administrator. */
    // @ApiMember(Description="The resource information connected to the administrator.")
    public Resource: CompanyUserResource;

    /** @description The roles that are connected to the administrator. */
    // @ApiMember(Description="The roles that are connected to the administrator.")
    public Roles: CompanyUserRolesQueryResponse[];

    public Active: boolean;
    public Created: string;
    public Updated: string;

    public constructor(init?: Partial<CompanyUserQueryResponse>) { (Object as any).assign(this, init); }
}

// @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)
export class SuperAdminDeleteCompanyUser implements ICompany
{
    /** @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. */
    // @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")
    public CompanyId?: string;

    /** @description Enter the user id for the administrator. */
    // @ApiMember(Description="Enter the user id for the administrator.", IsRequired=true, ParameterType="query")
    public Id: string;

    public constructor(init?: Partial<SuperAdminDeleteCompanyUser>) { (Object as any).assign(this, init); }
}

TypeScript SuperAdminDeleteCompanyUser 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 /superadmin/administrators/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyUserQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <Email>String</Email>
  <Firstname>String</Firstname>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Lastname>String</Lastname>
  <Phone>String</Phone>
  <Resource>
    <Active>false</Active>
    <Color>String</Color>
    <Description>String</Description>
    <Email>String</Email>
    <EmailNotification>false</EmailNotification>
    <EmailReminder>false</EmailReminder>
    <Id>0</Id>
    <ImageUrl i:nil="true" />
    <Name>String</Name>
    <Phone>String</Phone>
    <SMSNotification>false</SMSNotification>
    <SMSReminder>false</SMSReminder>
  </Resource>
  <ResourceId>0</ResourceId>
  <Roles>
    <CompanyUserRolesQueryResponse>
      <Description>String</Description>
      <Name>String</Name>
      <RoleId>00000000-0000-0000-0000-000000000000</RoleId>
    </CompanyUserRolesQueryResponse>
  </Roles>
  <Updated>0001-01-01T00:00:00</Updated>
  <WorkerId>String</WorkerId>
</CompanyUserQueryResponse>