BokaMera.API.Host

<back to all web services

CreateCompanyUser

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/administrators/Add a new administrator to your companyIf you want to add a new administrator to your company. A generated password will be sent to the user.
CreateCompanyUser Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company and id for the customer, if blank company id and you are an admin, your company id will be used.
FirstnamebodystringYes
LastnamebodystringYes
PhonebodystringYes
EmailbodystringYes
ResourceIdbodyint?No
RolesbodyList<AddCompanyUserRolesResponse>No
WorkerIdbodyint?No
AddCompanyUserRolesResponse Parameters:
NameParameterData TypeRequiredDescription
RoleIdformGuidNo
CompanyUserQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CompanyIdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
WorkerIdformstringNo
ResourceIdformint?No
ResourceformCompanyUserResourceNoThe resource information connected to the administrator.
RolesformList<CompanyUserRolesQueryResponse>NoThe roles that are connected to the administrator.
ActiveformboolNo
CreatedformDateTimeNo
UpdatedformDateTimeNo
CompanyUserResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource id
NameformstringNoThe resource name
ActiveformboolNoThe resource status
DescriptionformstringNoThe resource description
EmailformstringNoThe resource email
PhoneformstringNoThe resource phone
ColorformstringNoThe resource color
ImageUrlformUriNoThe resource image
EmailNotificationformboolNoIf the resource want to receive email notifications
SMSNotificationformboolNoIf the resource want to receive sms notifications
EmailReminderformboolNoIf the resource want to receive email reminders
SMSReminderformboolNoIf the resource want to receive sms reminders
CompanyUserRolesQueryResponse Parameters:
NameParameterData TypeRequiredDescription
RoleIdformGuidNo
NameformstringNo
DescriptionformstringNo

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.

POST /administrators/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateCompanyUser 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>
</CreateCompanyUser>
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>