| Requires the role: | superadmin |
| POST | /superadmin/administrators/ | Add a new administrator to your company | If you want to add a new administrator to your company. A generated password will be sent to the user. |
|---|
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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddCompanyUserRolesResponse:
role_id: Optional[str] = None
# @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 SuperAdminCreateCompanyUser(ICompany):
# @ApiMember(Description="Enter the company and id for the customer, 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 customer, if blank company id and you are an admin, your company id will be used.
"""
# @ApiMember(IsRequired=true)
firstname: Optional[str] = None
# @ApiMember(IsRequired=true)
lastname: Optional[str] = None
# @ApiMember(IsRequired=true)
phone: Optional[str] = None
# @ApiMember(IsRequired=true)
email: Optional[str] = None
# @ApiMember()
resource_id: Optional[int] = None
# @ApiMember()
roles: Optional[List[AddCompanyUserRolesResponse]] = None
# @ApiMember()
worker_id: Optional[int] = None
Python SuperAdminCreateCompanyUser DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /superadmin/administrators/ HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SuperAdminCreateCompanyUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Email>String</Email>
<Firstname>String</Firstname>
<Lastname>String</Lastname>
<Phone>String</Phone>
<ResourceId>0</ResourceId>
<Roles>
<AddCompanyUserRolesResponse>
<RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</AddCompanyUserRolesResponse>
</Roles>
<WorkerId>0</WorkerId>
</SuperAdminCreateCompanyUser>
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>