diff --git a/README.md b/README.md index c51aecd..0d755ac 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,23 @@ or the underlying checkText call errs out)
  • Expected Output: HTTP OK, with the number of flags (int)
    • +
    +POST: /register +
  • Purpose: Register a new organization
    • +
  • Expected Parameters: LoginRequest loginRequest -- an object containing an orgId and password.
    • +
  • Expected Output: HTTP OK Status with a boolean showing if the organization has been successfully registered
    • +
  • Upon Failure: HTTP Bad Request or Internal Server Error
    • +
    + +
    +POST: /login +
  • Purpose: Log a current organiztion in
    • +
  • Expected Parameters: LoginRequest loginRequest -- an object containing an orgId and password.
    • +
  • Expected Output: HTTP OK Status with a boolean showing if the organization has been successfully logged in or not
    • +
  • Upon Failure: HTTP Bad Request or Internal Server Error showing the user has failed to enter the correct orgId or password
    • +
    + + Note: we have incorporated login functionality. Each valid user and organization will need to re-enter their credentials every 24 hours. This check has been integrated into each of our endpoints.