BokaMera.API.Host

<back to all web services

UpdateUserEmail

The following routes are available for this service:
POST/users/confirmemailConfirm my new email
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)
public class UpdateUserEmail : Codable
{
    // @ApiMember(IsRequired=true)
    public var token:String

    /**
    * 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

    required public init(){}
}

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

public class UpdateUserEmailResponse : Codable
{
    public var responseStatus:String
    public var userId:String?
    public var email:String

    required public init(){}
}

Swift UpdateUserEmail 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.

POST /users/confirmemail HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateUserEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Realm>BookMore</Realm>
  <Token>String</Token>
</UpdateUserEmail>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateUserEmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Email>String</Email>
  <ResponseStatus />
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
</UpdateUserEmailResponse>