How To use API - rayutt/internet-tech GitHub Wiki

Documentation

/

Methods: HEAD, OPTIONS, GET

Arguments: None

Description: Displays the index page for the users.

/api/v1/<provider>/login

Methods: POST, OPTIONS

Arguments: provider

Description: Selects the login method app for local login and gamil for Oauth users wishing to use gmail. if successful a token is created.

/api/v1/<provider>/logout

Methods: POST, OPTIONS

Arguments: provider

Description: logs out the user from the application. The token is added to the server's database were it is recorded as an invalid token.

/api/v1/dates

Methods: HEAD, POST, OPTIONS, GET

Arguments: None

Description: Displays all the date information for a meal date lime. A token is required to access this feature. if successful date objects are returned in json format.

/api/v1/dates/int:id

Methods: PUT, HEAD, GET, OPTIONS, DELETE

Arguments: id

Description: Retrieves a date for particular a user and performs CRUD option using the selected method. A token is required to access this feature. If successful a date object is returned in json format.

/api/v1/proposals

**Methods: **HEAD, POST, OPTIONS, GET

Arguments: None

Description: Displays all proposals for a user. If successful proposal objects are returned in json.

/api/v1/proposals/int:id

Methods: PUT, HEAD, GET, OPTIONS, DELETE

Arguments: id

Description: Retrieves a proposal for particular a user and performs CRUD option using the selected method. A token is required to access this feature. If successful a proposal object is returned in json.

/api/v1/requests

Methods: HEAD, POST, OPTIONS, GET

Arguments: None

Description: Displays all requests for a user. A token is required to access this feature. If successful request objects are returned in json.

/api/v1/requests/int:id

Methods: PUT, HEAD, GET, OPTIONS, DELETE

Arguments: id

Description: Retrieves a request for particular a user and performs CRUD option using the selected method. A token is required to access this feature. If successful a request object is returned in json.

/api/v1/users

Methods: HEAD, GET, PUT, POST, OPTIONS, DELETE

Arguments: None

Description: Displays all registered users. If successful user objects are returned in json.

/api/v1/users/int:id

Methods: HEAD, OPTIONS, GET

Arguments: id

Description: Retrieves a date particular for a user and performs CRUD option using the selected method. A token is required to access this feature. If successful a user object is returned in json.

⚠️ **GitHub.com Fallback** ⚠️