BokaMera.API.Host

<back to all web services

UpdateCompanyUser

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/administrators/{Id}Update administrator on your companyIf you want to update a administrator to your company.
UpdateCompanyUser Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company and id for the application user, if blank company id and you are an admin, your company id will be used.
IdpathGuidYesEnter the user id for the administrator.
FirstnamebodystringNo
LastnamebodystringNo
PhonebodystringNo
EmailbodystringNo
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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /administrators/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
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/csv
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}