BokaMera.API.Host

<back to all web services

UpdateUser

Requires Authentication
The following routes are available for this service:
PUT/usersUpdate my informationUpdates the logged in users info both in customer profile and application admin profile if any exists. Users are only allowed to update their own info.
UpdateUser Parameters:
NameParameterData TypeRequiredDescription
UserIdbodyGuid?NoThe user id for your profile.
NewEmailbodystringYes
UserProfilebodyUpdateCustomerProfileYes
AdminProfilebodyUpdateAdminProfileYes
RealmbodyKeyCloakRealmYesThe user realm for identity server. BookMore = 1, BookMoreAdmin = 2
UpdateCustomerProfile Parameters:
NameParameterData TypeRequiredDescription
FirstnameformstringYes
LastnameformstringYes
PhoneformstringYes
EmailformstringYes
UpdateAdminProfile Parameters:
NameParameterData TypeRequiredDescription
FirstnameformstringYes
LastnameformstringYes
PhoneformstringYes
EmailformstringYes
KeyCloakRealm Enum:
NameValue
BookMore1
BookMoreAdmin2
SuperAdmin3
UpdateUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformObjectYes
UserIdformGuid?YesThe user id for your profile.
UserProfileformUserProfileResponseYes
AdminProfileformAdminProfileYes
IsSentConfirmationUpdateEmailformbool?No
UserProfileResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringYes
LastnameformstringYes
PhoneformstringYes
EmailformstringYes
AdminProfile Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
WorkerIdformstringNo
PhoneformstringNo

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.

PUT /users HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AdminProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </AdminProfile>
  <NewEmail>String</NewEmail>
  <Realm>BookMore</Realm>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <UserProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</UpdateUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AdminProfile>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
    <WorkerId>String</WorkerId>
  </AdminProfile>
  <IsSentConfirmationUpdateEmail>false</IsSentConfirmationUpdateEmail>
  <ResponseStatus />
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <UserProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</UpdateUserResponse>