BokaMera.API.Host

ForgotUserPassword

The following routes are available for this service:
POST	/users/forgotpassword	Forgot Password for user	Will send a restore password link to the user by the email provided.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <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 Partial Class ForgotUserPassword
            <ApiMember(IsRequired:=true)>
            Public Overridable Property Email As String

            '''<Summary>
            '''The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
            '''</Summary>
            <ApiMember(Description:="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired:=true)>
            Public Overridable Property Realm As KeyCloakRealm
        End Class

        Public Partial Class ForgotUserPasswordResponse
            Public Overridable Property Email As String
            Public Overridable Property ResponseStatus As Object
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum KeyCloakRealm
            BookMore = 1
            BookMoreAdmin = 2
            SuperAdmin = 3
        End Enum
    End Namespace
End Namespace

VB.NET ForgotUserPassword 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/forgotpassword HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

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