Versions Compared

Key

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

...

-Table comparing which language we are using / platform etc etc

Method

Name

Description

Parameters

Return values

Exceptions

POST

/auth/login

Logs user into their account and returns a token for their session

{

email: (String)

password: (String)

}

{

token : (String)

}

400 errors:

  • Invalid password or email

POST

/auth/logout

Logs user out of session and disconnects any tokens associated with them.

{

token: (String)

}

{

}

403:

  • Invalid token

POST

/auth/register

Creates new user and returns token for their session. Valid password is min 8 char, contains at least 1 upper case and 1 digit

{

email: (String)

password: (String)

}

{

token : (String)

}

400:

  • Invalid email or password

  • Email already registered

POST

/auth/remove

Deletes user. Also logs users out of any tokens currently associated with them.

{

token : (String)

}

{

}

403:

  • Invalid token

POST

/api/connect

Generates and returns tokens for UBL XML apis. Should logout/delete any existing tokens connected to session.

{

token : (String)

}

TO UPDATE WITH FINAL API CHOICES

{

send_token : (String)

}

403:

  • Invalid token

POST

/api/disconnect

Logout/delete any existing tokens connected to session.

{

token : (String)

}

{

}

403:

  • Invalid token

POST

/user/data

Updates/sets value of user for XML creation

TODO Add the values for this

{

}

{

}

403:

  • Invalid token

GET

/user/data

Returns values of user for XML creation

TODO Add the values for this

{

}

TODO Add the values for this

{

}

400:

  • No users values have been saved

403:

  • Invalid token