Requires the role: | superadmin |
DELETE | /superadmin/administrators/{Id} | Delete a administrator from your company | If you want to delete a administrator from your company. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | Enter the company and id for the application user, if blank company id and you are an admin, your company id will be used. |
Id | query | Guid | Yes | Enter the user id for the administrator. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
CompanyId | form | Guid | No | |
Firstname | form | string | No | |
Lastname | form | string | No | |
form | string | No | ||
Phone | form | string | No | |
WorkerId | form | string | No | |
ResourceId | form | int? | No | |
Resource | form | CompanyUserResource | No | The resource information connected to the administrator. |
Roles | form | List<CompanyUserRolesQueryResponse> | No | The roles that are connected to the administrator. |
Active | form | bool | No | |
Created | form | DateTime | No | |
Updated | form | DateTime | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The resource id |
Name | form | string | No | The resource name |
Active | form | bool | No | The resource status |
Description | form | string | No | The resource description |
form | string | No | The resource email | |
Phone | form | string | No | The resource phone |
Color | form | string | No | The resource color |
ImageUrl | form | Uri | No | The resource image |
EmailNotification | form | bool | No | If the resource want to receive email notifications |
SMSNotification | form | bool | No | If the resource want to receive sms notifications |
EmailReminder | form | bool | No | If the resource want to receive email reminders |
SMSReminder | form | bool | No | If the resource want to receive sms reminders |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RoleId | form | Guid | No | |
Name | form | string | No | |
Description | form | string | No |
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.
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>