BDG-11 Retrieve BadgeOS Principal

Use Case: Retrieve BadgeOS Principal

Given an Email Address, find the matching Principal (including WordPress User ID).

Actors

  • Badge API Client verified via session

Pre-Conditions

  • Session is established.
  • Have a String representation of the email address.

Steps

  1. Call API passing the email address
  2. Receive Badge OS Principal object:

Alternative Paths

  • TODO: Haven't determined what is returned when the email address isn't in WordPress; this indicates we want to add the user (or it may not).

Post-Conditions

Object that looks like this is returned:

public class BadgeOsPrincipal implements Principal {
    private Integer badgeOsUserId;
    private String name;
    private InternetAddress emailAddress;

References

ref1

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License