| A | B | C | D | E | F | G | H | I | |
|---|---|---|---|---|---|---|---|---|---|
1 | Resource | Método | Parametros | Respuesta | Ejemplo request | Ejemplo Response | |||
2 | Status | Detalle | Significado | Body | Status | Detalle | |||
3 | /usuarios | PUT | {usuario: <nombe>, password: <contraseña>} | 400 | {} | Nombre de usuario inválido | {usuario: 'tefi', password: '123'} | 400 | {} |
4 | 200 | {} | Usuario creado | {usuario: 'mvicent', password: '123'} | 200 | {} | |||
5 | POST | {usuario: <nombe>, password: <contraseña>} | 200 | {id: <idDelUsuario>} | Login correcto | {usuario: 'mvicent', password: '123'} | 200 | {id: 11} | |
6 | 401 | {} | Password incorrecto | {usuario: 'mvicent', password: 'nono'} | 401 | {} | |||
7 | 404 | {} | Usuario no encontrado | {usuario: 'no estoy', password: '123'} | 404 | {} | |||
8 | /evaluados | GET | {} | 200 | [{id: <idEvaluado>, tipo: <tipo: SERVICIO|LUGAR>, nombre: <nombre>}] | Lista de todos los posibles lugares o servicios habilitados para evaluarlos | {} | 200 | [{id: 1, tipo: 'SERVICIO', nombre: 'Aysa' },{id: 2, tipo: 'SERVICIO', nombre: 'Speedy' },{id: 1, tipo: 'LUGAR', nombre: 'Jobs' }, ...] |
9 | /ranking | GET | {} buscar por nombre, tipo, cantidad de calificaciones >=, rankig >= | 200 | [{evaluado:<lugar>, raking: <resultado>, calificaciones: <cantidad>}] | Lista de todos los posibles lugares o servicios habilitados para evaluarlos | todo con 2 o mas calificaciones | 200 | [{evaluado:{id: 2, tipo: 'SERVICIO', nombre: 'Speedy' }, raking:1, calificaciones: 2}, {evaluado: {id: 1, tipo: 'LUGAR', nombre: 'Jobs' }, raking:3, calificaciones: 5}, ... ] |
10 | /calificaciones | POST | 200 | Calificación realizada | 200 | ||||
11 | 400 | {} | No se informa el puntaje, el motivo de la puntuación o el evaluado | 400 | {} | ||||
12 | PUT | 200 | {} | Calificación editada | 200 | {} | |||
13 | 400 | {} | No se informa el puntaje, el motivo de la puntuación, el evaluado o el id de calificación modificada | 400 | {} | ||||
14 | 404 | {} | Calificación no encontrada | 404 | {} | ||||
15 | DELETE | 200 | {} | Calificación eliminada | 200 | {} | |||
16 | 400 | {} | No se informa id de calificación a eliminar | 400 | {} | ||||
17 | 404 | {} | Calificación no encontrada | 404 | {} | ||||
18 | GET | 200 | Listado de calificaciones hechas por el usuario | 200 | |||||