Syntch Gateway API

<back to all web services

PasswordResetRequest

Support - Password Reset
The following routes are available for this service:
POST/users/password-resetUser requesting password reset.
PasswordResetRequest Parameters:
NameParameterData TypeRequiredDescription
UserNamemodelstringYes
UserEmailmodelstringYes
LinkURLmodelstringYes
LanguageCodemodelLanguageCodeNo
LanguageCode Enum:
en_us
CommunicationStatus Parameters:
NameParameterData TypeRequiredDescription
StatusCodeformintNo
StatusStringformstringNo

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/password-reset HTTP/1.1 
Host: syntch.simpay.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PasswordResetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.RestApi.Users.BindingModels">
  <LanguageCode>en_us</LanguageCode>
  <LinkURL>String</LinkURL>
  <UserEmail>String</UserEmail>
  <UserName>String</UserName>
</PasswordResetRequest>

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

<CommunicationStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gateway.Infrastructure.Common">
  <StatusCode>0</StatusCode>
  <StatusString>String</StatusString>
</CommunicationStatus>