Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • HTTP request headers:
    • Content-Type: text/plain
  • HTTP query string parameters:
    • emailType: valid open registry email reference type e.g. CAMPUS, HOME, etc.
    • identifierType: valid open registry person's identifier type e.g. NETID, RCPID, etc.
    • identifier: valid person's identifier value of the provided identifier type e.g. tako, abc123, etc.
    • affiliation: valid open registry Sor Role's affiliation e.g. STUDENT, FACULTY, etc.
  • HTTP request entity body:
    • Valid email address of the person in question
  • HTTP response entity body:
    • Success message (in case of 200)
    • Error message(s) (in any other cases)
  • HTTP status codes:
    • 200: the email has been successfully processed (created or updated)
    • 405: an HTTP method other than POST is used
    • 415: Content-Type HTTP request header other than text/plain is used
    • 404: URI identifies a nonexistent person
    • 400: any of the query string parameters are not provided
    • 400: provided emailType or affiliation are invalid
    • 400: provided email address is malformed
    • 409: if there are internal state conflicts e.g. there are no open roles for the person in question
    • 401/403: the authentication/authorization fails
    • 500: any other server error that occurs