Introduction#
Descripcion general#
Este sistema organiza la informacion relacionada a las transacciones de la Asociacion de Estudiantes de Ciencia de Computos (AECC) de la Universidad de Puerto Rico, Recinto de Rio Piedras. Este sistema tiene 5 tipos de datos fundamentales para su uso:
- productos
- transacciones
- miembros de la AECC
- miembros de directiva
- actividades hechas por la AECC
Productos#
Un producto es una entidad de
Proposito del sistema#
Anterior a la implementacion de este sistema, la AECC mantenia los records de transacciones a mano. Esto es
- Alcance del sistema
Sistema actual (si fuera el caso)#
Requisitos#
- Funcionales
- los requisitos funcionales describen la funcionalidad del sistema. Un ejemplo puede ser, el sistema debe presentar el orario de clase del estudiante.
- No funcionales
- Usabilidad
- Fiabilidad
- Rendimiento
API Endpoints#
Create a resource in the database#
https://ada.uprrp.edu/~diego.estrada1/CCOM/4027/db/api/v1/create/
- permiso: ninguno[2][3]
- metodo:
POST - parametros:
| Campo | Tipo | Descripcion |
|---|---|---|
t |
String |
Tabla en la que quieras crear una tupla.[4] |
cents |
int |
Cantidad de centavos para un product. |
description |
String |
Descripcion para un product. |
- respuestas:
- Exito:
- 201: La tupla se inserto exitosamente.
- Devuelve los valores de la tupla en la tabla.
- 201: La tupla se inserto exitosamente.
- Fallo:
- 200: Error con el lenguaje de PHP.[5]
- 400: Error con los parametros que se enviaron.
- 500: Error insertando la tupla en la tabla.
- Exito:
/api/v1/read/#
https://ada.uprrp.edu/~diego.estrada1/CCOM/4027/db/api/v1/read/
- permiso: ninguno[2][3]
- metodo:
POST - parametros:
| Campo | Tipo | Descripcion |
|---|---|---|
t |
String |
Tabla en la que quieras buscar.[4] |
id |
int |
ID de la tupla que quieras buscar.[4] |
q |
String |
Texto que quieras buscar en atributos FULLTEXT. |
- respuestas:
- Exito:
- 201: Se hizo la busqueda adecuadamente.
- Devuelve los valores de las tuplas que se encontraron.
- 201: Se hizo la busqueda adecuadamente.
- Fallo:
- 200: Error con el lenguaje de PHP.[5]
- 400: Error con los parametros que se enviaron.
- 500: Error buscando tuplas en la tabla.
- Exito:
/api/v1/update/#
- method:
POST[1]
/api/v1/delete/#
- method:
POST[1]
Footer#
- [1]: Por restricciones de ADA, no se pueden hacer requests de
PUToDELETE. Por lo tanto, en este proyecto solo se utilizaranGETyDELETE. - [2]: Por restricciones de tiempo el API esta abierto a quien sea.
- [3]: En el futuro, el permiso sera:
Treasurer,President,VicePresident. - [4]: Las tablas disponibles son:
board_membermemberactivity_transactionactivitytransactionloggerinitiatorproduct
- [5]: Cuando ocurre un error con PHP, la respuesta vuelve como 200 y no hay manera de cambiar eso.
- [6]: Como esta pagina es un "single page application", este request se ve
mejor por
POSTpara no afectar el URL de la pagina. Sin embargo, deberia ser porGET.
Entrega hasta aqu'i
- Restricciones organizacionales al dise~no
- Asuntos legales
Refencias#
Glosario#
Proyecto#
- Entrevistar a las personas encargadas para entender la tarea y definir requisitos. Al completar la entrevista deben tener toda la informaci'on necesaria para poder hacer los diagramas.
- Crear el diagrama de la base de datos y dise~nar la base de datos. La base de datos debe tener al menos tres entidades y dos relaciones.
- Crear el diagrama de flujo de la informaci'on y diagrama de la interfaz (wire frame).
La interfaz debe tener al menos tres p'aginas (views), uno que presente la aplicaci'on y de instrucciones, uno que requiera la manipulacion de datos en la base de datos y uno que muestre datos seleccionados de la base de datos (
select). La p'agina que manipula datos debe poder hacerinsert,updateydelete. - Crear las tablas con SQL en el sistema MySQL.
- Desarrollar la interfaz usando
htmlyphp.