Members: Generate Recovery Code

michael-e edited this page May 11, 2011 · 2 revisions

Example Error XML:

<members-generate-recovery-code result="error">
  <username type="missing" message="USERNAME is a required field." label="USERNAME" />
  <username type="invalid" message="Member not found." label="USERNAME" />
  <email type="missing" message="EMAIL is a required field." label="EMAIL" />
  <email type="invalid" message="Member not found." label="EMAIL" />
  <error type="invalid" message="No Identity field found." />
  <error type="invalid" message="You cannot generate a recovery code while being logged in."/>
  <post-values>
    <username>Hello</username>
    <email>hello@example.com</email>
  </post-values>
</members-generate-recovery-code>

Example Success XML (may include a filter element from an etm- or etf- filter):

<members-generate-recovery-code result="success">
  <filter name="etm-members-send-recovery-code" status="passed" total="1" sent="1" />
  <recovery-code>357bad74966064aa78821f51171657c768885828</recovery-code>
  <post-values>
    <username>Hello</username>
  </post-values>
</members-generate-recovery-code>

Detailed list of possible error responses

Errors if username field is used:

<members-generate-recovery-code result="error">
  <username type="missing" message="USERNAME is a required field." label="USERNAME" />
  <post-values />
</members-generate-recovery-code>

<members-generate-recovery-code result="error">
  <username type="invalid" message="Member not found." label="USERNAME" />
  <post-values>
    <username>Hellooo</username>
  </post-values>
</members-generate-recovery-code>

Errors if email field is used:

<members-generate-recovery-code result="error">
  <email type="missing" message="EMAIL is a required field." label="EMAIL" />
  <post-values />
</members-generate-recovery-code>

<members-generate-recovery-code result="error">
  <email type="invalid" message="Member not found." label="EMAIL" />
  <post-values>
    <email>hellooo@example.com</email>
  </post-values>
</members-generate-recovery-code>

Error if no field value is found:

<members-generate-recovery-code result="error">
  <error type="invalid" message="No Identity field found." />
  <post-values />
</members-generate-recovery-code>
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.