YM REST Services

<back to all web services

PasswordValidityRequest

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:/admin/members/
The following routes are available for this service:
GET/Ams/{ClientID}/CheckPasswordReturn whether the given password follows the YM format standard.
PasswordValidityRequest Parameters:
NameParameterData TypeRequiredDescription
PasswordquerystringNo
UsernamequerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PasswordValidity Parameters:
NameParameterData TypeRequiredDescription
ValidformboolNo
ErrorMessageformstringNo

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.

GET /Ams/{ClientID}/CheckPassword HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PasswordValidity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <ErrorMessage>String</ErrorMessage>
  <Valid>false</Valid>
</PasswordValidity>