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 Foundation
import ServiceStack

// @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")
public class UpdateUser : Codable
{
    /**
    * The user id for your profile.
    */
    // @ApiMember(Description="The user id for your profile.")
    public var userId:String?

    public var newEmail:String
    public var userProfile:UpdateCustomerProfile
    public var adminProfile:UpdateAdminProfile
    /**
    * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    */
    // @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    public var realm:KeyCloakRealm

    public var invoiceAddress:InvoiceAddressToHandle

    required public init(){}
}

public class UpdateCustomerProfile : Codable
{
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String
    public var invoiceAddress:InvoiceAddressResponse

    required public init(){}
}

public class InvoiceAddressResponse : Codable
{
    public var invoiceAddressId:String
    public var userId:String?
    public var corporateIdentityNumber:String
    public var invoiceAddress1:String
    public var invoiceAddress2:String
    public var invoiceCity:String
    public var invoicePostalCode:String
    public var invoiceCountryCode:String

    required public init(){}
}

public class UpdateAdminProfile : Codable
{
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String

    required public init(){}
}

public enum KeyCloakRealm : Int, Codable
{
    case BookMore = 1
    case BookMoreAdmin = 2
    case SuperAdmin = 3
}

public class InvoiceAddressToHandle : IInvoiceAddress, Codable
{
    public var corporateIdentityNumber:String
    public var invoiceAddress1:String
    public var invoiceAddress2:String
    public var invoiceCity:String
    public var invoicePostalCode:String
    public var invoiceCountryCode:String

    required public init(){}
}

public class UpdateUserResponse : Codable
{
    public var responseStatus:String
    /**
    * The user id for your profile.
    */
    // @ApiMember(Description="The user id for your profile.", IsRequired=true)
    public var userId:String?

    public var userProfile:UserProfileResponse
    public var adminProfile:AdminProfile
    public var isSentConfirmationUpdateEmail:Bool?
    public var invoiceAddress:InvoiceAddressResponse

    required public init(){}
}

public class UserProfileResponse : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String
    public var invoiceAddress:InvoiceAddressResponse

    required public init(){}
}

public class AdminProfile : Codable
{
    public var companyId:String
    public var id:String
    public var firstname:String
    public var lastname:String
    public var email:String
    public var workerId:String
    public var phone:String

    required public init(){}
}

Swift 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: testapi.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>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
  </InvoiceAddress>
  <NewEmail>String</NewEmail>
  <Realm>BookMore</Realm>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <UserProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <InvoiceAddress>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
    </InvoiceAddress>
    <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>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
    <UserId>00000000-0000-0000-0000-000000000000</UserId>
  </InvoiceAddress>
  <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>
    <InvoiceAddress>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
    </InvoiceAddress>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</UpdateUserResponse>