YM REST Services

<back to all web services

MemberPasswordReset

The following routes are available for this service:
POST/Ams/MemberPasswordResetSend member password reset instructions to client via email.
MemberPasswordReset Parameters:
NameParameterData TypeRequiredDescription
UsernamebodystringNo
EmailbodystringNo
ClientIDbodyintNo
MobilebodyboolNo
ResetTokenbodystringNo
NewPasswordbodystringNo
MemberPasswordResetResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseCodeformResponseCodeNo
ResponseTextformstringNo
ResponseStatusformResponseStatusNo

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 /Ams/MemberPasswordReset HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MemberPasswordReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <ClientID>0</ClientID>
  <Email>String</Email>
  <Mobile>false</Mobile>
  <NewPassword>String</NewPassword>
  <ResetToken>String</ResetToken>
  <Username>String</Username>
</MemberPasswordReset>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MemberPasswordResetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <ClientID>0</ClientID>
  <Email>String</Email>
  <Mobile>false</Mobile>
  <NewPassword>String</NewPassword>
  <ResetToken>String</ResetToken>
  <Username>String</Username>
  <ResponseCode>Success</ResponseCode>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ResponseText>String</ResponseText>
</MemberPasswordResetResponse>