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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateUser
{
    /**
    * The user id for your profile.
    */
    @ApiMember(Description="The user id for your profile.")
    var UserId:UUID? = null

    var NewEmail:String? = null
    var UserProfile:UpdateCustomerProfile? = null
    var AdminProfile:UpdateAdminProfile? = null
    /**
    * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    */
    @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    var Realm:KeyCloakRealm? = null
}

open class UpdateCustomerProfile
{
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
}

open class UpdateAdminProfile
{
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
}

enum class KeyCloakRealm(val value:Int)
{
    BookMore(1),
    BookMoreAdmin(2),
    SuperAdmin(3),
}

open class UpdateUserResponse
{
    var ResponseStatus:Object? = null
    /**
    * The user id for your profile.
    */
    @ApiMember(Description="The user id for your profile.", IsRequired=true)
    var UserId:UUID? = null

    var UserProfile:UserProfileResponse? = null
    var AdminProfile:AdminProfile? = null
    var IsSentConfirmationUpdateEmail:Boolean? = null
}

open class UserProfileResponse
{
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
}

open class AdminProfile
{
    var CompanyId:UUID? = null
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var WorkerId:String? = null
    var Phone:String? = null
}

Kotlin UpdateUser DTOs

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>