Skip to content

AWS2/matrics-app

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 

Repository files navigation

app


ENDPOINTS DOCUMENTATION:

Alumn Login

REQUEST

Request : JSON
POST /api/token
Param Values Description
email text Email de usuari
password text Password del usuari hasheada a SHA256

RESPONSE

Response : JSON
POST
Param Values Description
status text OK o KO dependiendo de si el login ha sido correcto o no
statusData text en caso de OK será el token con el user_id y la caducidad dentro, en caso de KO será el mensaje de error con el motivo
statusMatricula int 0 si no se han puesto los documentos necesarios para el perfil, 1 si los documentos están pendientes de verificación, y 2 cuando la matrícula ya se ha completado
boolWizard boolean true si ya ha configurado su perfil con el wizard y false si todavía no lo ha hecho

Get profiles and requirements

REQUEST (url query)

Request : JSON
GET /api/profilesandrequirements
Param Values Description
token text Token de usuario

RESPONSE STATUS 200

Response : JSON
GET /get/grade
Param Values Description
Se devuelve un array de JSON que contiene los perfiles de la base de datos y dentro otro array con sus respectivos requisitos.

RESPONSE STATUS 400

Response : JSON
GET /get/grade
Param Values Description
error text Motivo del error

Get Grade

REQUEST (url query)

Request (url query)
GET /api/career
Param Values Description
token text Token del usuario
carreerCode text Codigo del ciclo

RESPONSE STATUS 200

Response : JSON
GET
Param Values Description
Se devuelve un objeto JSON de grado entero, igual que el de base de datos.

RESPONSE STATUS 400

Response : JSON
GET
Param Values Description
error text Motivo del error

Insert wizard

REQUEST

Request : JSON(Array)
POST
Param Values Description
documentsProfile JSON Object Se debe informar de un objeto JSON de perfil entero, igual que el de base de datos.
overwritetextPermite sobreescribir en caso de que ya exista un perfil con el mismo nombre. Debe ser "true" o "false" en texto plano

RESPONSE STATUS 200

Response : JSON
POST /insert/documentsProfile
Param Values Description
insertCount integer Numero de inserciones

RESPONSE STATUS 400

Response : JSON
POST /insert/documentsProfile
Param Values Description
error text Motivo del error

Get user info

REQUEST

Request
GET /api/user
Param Values Description
token text Token de usuario

RESPONSE STATUS 200

Response : JSON
GET
Param Values Description
name text Nombre del usuario
firstSurname text Primer apellido del usuario
secondSurname text Segundo apellido del usuario
DNI text DNI del usuario
birthplace text Lugar de nacimiento del usuario
birthday text Fecha de nacimiento del usuario
address text Dirección del usuario
city text Ciudad del usuario
postal_code text Código postal del usuario
phone_number text Número de telefono del usuario
emergency_number text Número de telefono de emergéncia del usuario
tutor_1 text Primer tutor del usuario
tutor_2 text Segundo tutor del usuario

RESPONSE STATUS 400

Response : JSON
GET
Param Values Description
error text Motivo del error

Get image rights

REQUEST

Request
GET
Param Values Description
token text Token de usuario

RESPONSE STATUS 200

Response : Text
GET
Param Values Description
imageRightsText text Texto de los derechos de imagen

RESPONSE STATUS 400

Response : text
GET
Param Values Description
error text Motivo del error

Insert image rights

REQUEST

Request : text
POST
Param Values Description
imageRightsTest Text Texto de los derechos que ha aceptado el usuario

RESPONSE STATUS 200

Response
POST
Param Values Description

RESPONSE STATUS 400

Response : JSON
POST
Param Values Description
error text Motivo del error

Get document requirements

REQUEST

Request
GET
Param Values Description
token text Token de usuario

RESPONSE STATUS 200

Response : JSON(Array)
GET
Param Values Description
documentRequirements JSON Object Objeto JSON de los requisitos de documentos

RESPONSE STATUS 400

Response : text
GET
Param Values Description
error text Motivo del error

Get user UFs

REQUEST

Request
GET
Param Values Description
token text Token de usuario

RESPONSE STATUS 200

Response : JSON(Array)
GET
Param Values Description
ufList JSON Array de las UFs seleccionadas por el usuario a la hora de matricularse(Almacenado en el user)

RESPONSE STATUS 400

Response : text
GET
Param Values Description
error text Motivo del error

Insert user UFs

REQUEST

Request : JSON(Array)
POST
Param Values Description
ufList JSON Array de las UFs seleccionadas por el usuario a la hora de matricularse(Almacenado en el user)

RESPONSE STATUS 200

Response
POST
Param Values Description

RESPONSE STATUS 400

Response : JSON
POST
Param Values Description
error text Motivo del error

Upload Documents File

REQUEST

Request : FORM DATA
POST
Param Values Description
tokenTextToken del alumno
filearchivoFichero que se sube en base 64

RESPONSE STATUS 200

Response : JSON
POST
Param Values Description
ok text contiene "Fichero subido correctamente"

RESPONSE STATUS 400

Response : JSON
POST
Param Values Description
error text Motivo del error

Get Document

REQUEST

Request : GET
GET
Param Values Description
emailTextEmail del alumno
profileNametextNombre del perfil
documentNametextNombre del documento

RESPONSE STATUS 200

Response : JSON
GET
Param Values Description
filePath text contiene la ruta del fichero (incluye el nombre y extension)
data text Fichero en string base64

RESPONSE STATUS 400

Response : JSON
GET
Param Values Description
error text Motivo del error

Update, validate file

REQUEST

Request : POST
POST /update/validateFile
Param Values Description
emailTextEmail del alumno
profileNametextNombre del perfil
documentNametextNombre del documento

RESPONSE STATUS 200

Response : JSON
POST /update/validateFile
Param Values Description
ok text contiene "fichero validado correctamente"

RESPONSE STATUS 400

Response : JSON
POST /update/validateFile
Param Values Description
error text Motivo del error

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published