BokaMera.API.Host

<back to all web services

ForgotUserPassword

The following routes are available for this service:
POST/users/forgotpasswordForgot Password for userWill send a restore password link to the user by the email provided.
ForgotUserPassword Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringYes
RealmbodyKeyCloakRealmYesThe user realm for identity server. BookMore = 1, BookMoreAdmin = 2
KeyCloakRealm Enum:
NameValue
BookMore1
BookMoreAdmin2
SuperAdmin3
ForgotUserPasswordResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
ResponseStatusformObjectNo

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: testapi.bokamera.se 
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>