Requires the role: | superadmin |
PUT | /superadmin/administrators/{Id} | Update administrator on your company | If you want to update a administrator to 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 | path | Guid | Yes | Enter the user id for the administrator. |
Firstname | body | string | No | |
Lastname | body | string | No | |
Phone | body | string | No | |
body | string | No | ||
ResourceId | body | int? | No | |
Roles | body | List<AddCompanyUserRolesResponse> | No | |
WorkerId | body | int? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RoleId | form | Guid | No |
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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /superadmin/administrators/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Firstname: String,
Lastname: String,
Phone: String,
Email: String,
ResourceId: 0,
Roles:
[
{
}
],
WorkerId: 0
}
HTTP/1.1 200 OK Content-Type: text/jsv 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 }