CONTaFin - API REST Documentation

About our API

All you can find in our API Rest is information about users, loans, fines (penalties), resources, types, copies and genres. All you need to do is simply; you have to follow the API rules. If you try to do following a different way, it's probably what you will recieve an error.

How to use our API

Download Postman.
You only can send GET, POST, PUT and DELETE requests.

API requests

Resources

The resource API has GET, POST, PUT and DELETE methods. http: // localhost: 8080 followed by the containt request URL.

All API queries have been preceded by /api

Authentication

login

Allows a user to log in.

URL:

< /login >
Method:

GET

Success Response:

 {
     "id": 1,
     "name": "User",
     "email": "email@hotmail.es",
     "level": 1,
     "points": 0,
     "streak": 0,
     "fluency": 0,
     "dailyGoal": 0,
     "lastConnection": "2018-03-17/11:44:21",
     "lastUnit": 0,
     "lastLesson": 0,
     "progress": null,
     "remainingGoals": 0,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED

loguot

Allows a user to log out.

URL:

< /logout >
Method:

GET
Success Response:
```
 true
```
- Error Response:
  
  Code: 404 NOT FOUND

Admin

The following queries will be preceded by /Admin.

Obtain user data

Resource to show all users with their data.

URL

< /UserData >
Method:

GET
URL Params:
- page=[int]
- size=[int]
Example of query:
- URL
  
  /api/Admin/UserData/?page=1&size=10

Success Response:

 {
     "totalElements": 44,
     "totalPages": 5,
     "number": 1,
     "size": 10,
     "first": false,
     "last": false,
     "content": [
 	{
 	    "id": 11,
 	    "name": "user 7",
 	    "email": "email7@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 12,
 	    "name": "user 8",
 	    "email": "email8@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 13,
 	    "name": "user 9",
 	    "email": "email9@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 14,
 	    "name": "user 10",
 	    "email": "email10@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 15,
 	    "name": "user 11",
 	    "email": "email11@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 16,
 	    "name": "user 12",
 	    "email": "email12@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 17,
 	    "name": "user 13",
 	    "email": "email13@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 18,
 	    "name": "user 14",
 	    "email": "email14@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 19,
 	    "name": "user 15",
 	    "email": "email15@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	},
 	{
 	    "id": 20,
 	    "name": "user 16",
 	    "email": "email16@hotmail.es",
 	    "level": 1,
 	    "points": 0,
 	    "streak": 0,
 	    "fluency": 0,
 	    "dailyGoal": 0,
 	    "lastConnection": "-",
 	    "lastUnit": 0,
 	    "lastLesson": 0,
 	    "progress": null,
 	    "remainingGoals": 0,
 	    "exp": 0
 	}
     ]
 }

Error Response:

Code: 401 UNAUTHORIZED

Export data from all users

Resource to obtain an excel with the data of the users.

URL

< /UserData/Excel >
Method:

GET
Success Response:
```
 file: user_list.xls
```
Error Response:

Code: 403 FORBIDDEN

Users

The following queries will be preceded by /User.

Resource to show a user

URL

< />
Method:

GET

Success respone:

 {
     "id": 1,
     "name": "user",
     "email": "---@hotmail.es",
     "level": 2,
     "points": 12,
     "streak": 1,
     "fluency": 16,
     "dailyGoal": 1,
     "lastConnection": "2018-03-17/18:36:07",
     "lastUnit": 1,
     "lastLesson": 1,
     "progress": [
 	0,
 	1,
 	0,
 	0,
 	0,
 	0,
 	0
     ],
     "remainingGoals": 0,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED

Change the name of user

URL

< /Name>
Método:

PUT
Data Params
```
 {
     "newName": "Contafin"
 }
```

Success response:

 {
     "id": 1,
     "name": "Contafin",
     "email": "email@hotmail.es",
     "level": 2,
     "points": 12,
     "streak": 1,
     "fluency": 16,
     "dailyGoal": 1,
     "lastConnection": "2018-03-17/18:36:07",
     "lastUnit": 1,
     "lastLesson": 1,
     "progress": [
 	0,
 	1,
 	0,
 	0,
 	0,
 	0,
 	0
     ],
     "remainingGoals": 0,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED or 400 BAD REQUEST

Change the email of user

URL

< /Email>
Method:

PUT

Data Params

 {
     "newEmail": "contafin@hotmail.es"
 }

Success response:

 {
     "id": 1,
     "name": "Contafin",
     "email": "contafin@hotmail.es",
     "level": 2,
     "points": 12,
     "streak": 1,
     "fluency": 16,
     "dailyGoal": 1,
     "lastConnection": "2018-03-17/18:39:23",
     "lastUnit": 1,
     "lastLesson": 1,
     "progress": [
 	0,
 	1,
 	0,
 	0,
 	0,
 	0,
 	0
     ],
     "remainingGoals": 0,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED or 400 BAD REQUEST

Change the password of user

URL

< /Password>
Method:

PUT

Data Params

 {
     "newPass": "******"
     "oldPass": "******"
 }

Success response:

 {
     "id": 1,
     "name": "Contafin",
     "email": "contafin@hotmail.es",
     "level": 2,
     "points": 12,
     "streak": 1,
     "fluency": 16,
     "dailyGoal": 1,
     "lastConnection": "2018-03-17/18:40:02",
     "lastUnit": 1,
     "lastLesson": 1,
     "progress": [
 	0,
 	1,
 	0,
 	0,
 	0,
 	0,
 	0
     ],
     "remainingGoals": 0,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED or 400 BAD REQUEST

Resource to update goal of user

URL

< /Goal>
Method:

PUT
Data Params
```
 {
     "goal": "1"
 }
```

Success response:

 {
     "id": 1,
     "name": "Contafin",
     "email": "contafin@hotmail.es",
     "level": 2,
     "points": 12,
     "streak": 1,
     "fluency": 16,
     "dailyGoal": 3,
     "lastConnection": "2018-03-17/18:45:36",
     "lastUnit": 1,
     "lastLesson": 1,
     "progress": [
 	0,
 	1,
 	0,
 	0,
 	0,
 	0,
 	0
     ],
     "remainingGoals": 3,
     "exp": 0
 }

Error response:

Code: 401 UNAUTHORIZED or 400 BAD REQUEST

Resource to upload user profile image

URL

< /Photo>
Method:

POST

Data Params

 file: image file format (*.jpg, *.jpeg, *.png)

Error response:

Code: 401 UNAUTHORIZED or 400 BAD REQUEST or 500 INTERNAL SERVER ERROR

Resource to delete a user

URL

< />
Método:

DELETE
Error Response:
- Code: 404 NOT FOUND or 401 UNAUTHORIZED

Unit

The following queries will be preceded by /Unit.

Resource to show all units

URL:

< / >
Method:

GET
URL Params:

Empty
Example of query:
- URL
  
  /api/Unit/

Success response:

 {
     "totalElements": 2,
         "totalPages": 1,
     "number": 0,
     "size": 20,
     "first": true,
     "last": true,
     "content": [
 	{
 	    "id": 1,
 	    "name": "Unidad 1"
 	},
 	{
 	    "id": 2,
 	    "name": "Unidad 2"
 	}
     ]
 }

Resource to show one unit

URL:

< /{id} >
Method:

GET
URL Params:

id=[long]
Example of query:
- URL
  
  /api/Unit/1

Success response:

 {
     "id": 1,
     "name": "Unidad 1"
 }

Error response:

Code: 404 NOT FOUND

Create Unit with its lessons and exercises

URL:

< / >
Method:

POST
URL Params:

Empty
Example of query:
- URL
  
  /api/Unit/

Data params:

 {
     "name": "Unidad 3",
     "lessons": [
 	{
 	    "id": 7,
 	    "name": "Lección 1 Unidad 3",
 	    "exercises": [
 		{
 			"kind": 1,
 			"statement": "Enunciado 1",
 			"texts": [ "Opcion 1", "Opcion 2","Opcion 3" ],
 			"answer": {
 				"result": "dos"
 			}
 		},
 		{
 			"kind": 2,
 			"statement": "Enunciado 2",
 			"answer": {
 				"result": "Este texto es de prueba"
 			}
 		},
 		{
 			"kind": 5,
 			"statement": "Enunciado 3",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "uno"
 			}
 		},
 		{
 			"kind": 7,
 			"statement": "Enunciado 4",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "tres"
 			}
 		}
 	    ]
 	},
 	{
 	    "id": 8,
 	    "name": "Lección 2 Unidad 3",
 	    "exercises": [
 		{
 			"kind": 1,
 			"statement": "Enunciado 1",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "dos"
 			}
 		},
 		{
 			"kind": 2,
 			"statement": "Enunciado 2",
 			"answer": {
 				"result": "Este texto es de prueba"
 			}
 		},
 		{
 			"kind": 5,
 			"statement": "Enunciado 3",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "uno"
 			}
 		},
 		{
 			"kind": 7,
 			"statement": "Enunciado 4",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "tres"
 			}
 		}
 	    ]
 	},
 	{
 	    "id": 9,
 	    "name": "Lección 3 Unidad 3",
 	    "exercises": [
 		{
 			"kind": 1,
 			"statement": "Enunciado 1",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "dos"
 			}
 		},
 		{
 			"kind": 2,
 			"statement": "Enunciado 2",
 			"answer": {
 				"result": "Este texto es de prueba"
 			}
 		},
 		{
 			"kind": 5,
 			"statement": "Enunciado 3",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "uno"
 			}
 		},
 		{
 			"kind": 7,
 			"statement": "Enunciado 4",
 			"texts": [ "Opcion 1", "Opcion 2", "Opcion 3" ],
 			"answer": {
 				"result": "tres"
 			}
 		}
 	    ]
 	}
     ]
 }

Success response:

 {
     "id": 3,
     "name": "Unidad 3",
     "lessons": [
 	{
 	    "id": 7,
 	    "name": "Lección 1 Unidad 3",
 	    "exercises": [
 		{
 		    "id": 25,
 		    "kind": 1,
 		    "statement": "Enunciado 1",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 26,
 		    "kind": 2,
 		    "statement": "Enunciado 2",
 		    "texts": null
 		},
 		{
 		    "id": 27,
 		    "kind": 5,
 		    "statement": "Enunciado 3",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 28,
 		    "kind": 7,
 		    "statement": "Enunciado 4",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		}
 	    ]
 	},
 	{
 	    "id": 8,
 	    "name": "Lección 2 Unidad 3",
 	    "exercises": [
 		{
 		    "id": 29,
 		    "kind": 1,
 		    "statement": "Enunciado 1",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 30,
 		    "kind": 2,
 		    "statement": "Enunciado 2",
 		    "texts": null
 		},
 		{
 		    "id": 31,
 		    "kind": 5,
 		    "statement": "Enunciado 3",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 32,
 		    "kind": 7,
 		    "statement": "Enunciado 4",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		}
 	    ]
 	},
 	{
 	    "id": 9,
 	    "name": "Lección 3 Unidad 3",
 	    "exercises": [
 		{
 		    "id": 33,
 		    "kind": 1,
 		    "statement": "Enunciado 1",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 34,
 		    "kind": 2,
 		    "statement": "Enunciado 2",
 		    "texts": null
 		},
 		{
 		    "id": 35,
 		    "kind": 5,
 		    "statement": "Enunciado 3",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		},
 		{
 		    "id": 36,
 		    "kind": 7,
 		    "statement": "Enunciado 4",
 		    "texts": [
 			"Opcion 1",
 			"Opcion 2",
 			"Opcion 3"
 		    ]
 		}
 	    ]
 	}
     ]
 }

Success response:
```
 true
```
Error response:

Code: 404 NOT FOUND

Upload images of the unit created

URL:

< / {id}/Images>
Method:

POST
URL Params:

id=[long]
URL Params:

Empty
Example of query:
- URL
  
  /api/Unit/1/Images

Data Params:

 images[]: image file format (*.jpg, *.jpeg, *.png) (length = 9)

Error response:

Code: 500 INTERNAL SERVER ERROR or 400 BAD REQUEST

Change the name of the unit

URL:

< /{id} >
Method:

PUT
URL Params:

id=[long]
Example of query:
- URL
  
  /api/Unit/1
Data Params:
```
 {
 	"name": "Unidad Prueba"
 }
```

Success response:

 {
     "id": 1,
     "name": "Unidad Prueba"
 }

Error response:

Code: 404 NOT FOUND

Delete unit

URL:

< /{id} >
Method:

DELETE
URL Params:

id=[long]
Example of query:
- URL
  
  /api/Unit/1
Data Params:
```
 {
 	"name": "Unidad Prueba"
 }
```

Success response:

 {
     "id": 1,
     "name": "Unidad Prueba"
 }

Error response:

Code: 404 NOT FOUND

Lesson

The following queries will be preceded by /Unit.

Resource to show all lessons

URL:

< /Lessons/ >
Method:

GET
URL Params:

Empty
Example of query:
- URL
  
  /api/Unit/Lessons/

Success response:

 {
     "totalElements": 6,
     "totalPages": 1,
     "number": 0,
     "size": 20,
     "first": true,
     "last": true,
     "content": [
 	{
 	    "id": 4,
 	    "name": "Lección 1 Unidad 2"
 	},
 	{
 	    "id": 5,
 	    "name": "Lección 2 Unidad 2"
 	},
 	{
 	    "id": 6,
 	    "name": "Lección 3 Unidad 2"
 	},
 	{
 	    "id": 7,
 	    "name": "Lección 1 Unidad 3"
 	},
 	{
 	    "id": 8,
 	    "name": "Lección 2 Unidad 3"
 	},
 	{
 	    "id": 9,
 	    "name": "Lección 3 Unidad 3"
 	}
     ]
 }

Resource to show an unit with its lessons

URL:

< /{idunit}/Lesson/ >
Method:

GET
URL Params:

idunit=[long]
Example of query:
- URL
  
  /api/Unit/1/Lesson/

Success response:

 {
     "id": 1,
     "name": "Unidad 1",
     "lessons": [
 	{
 	    "id": 1,
 	    "name": "Lección 1 Unidad 1",
 	    "exercises": null
 	},
 	{
 	    "id": 2,
 	    "name": "Lección 2 Unidad 1",
 	    "exercises": null
 	},
 	{
 	    "id": 3,
 	    "name": "Lección 3 Unidad 1",
 	    "exercises": null
 	}
     ]
 }

Error response:

Code: 404 NOT FOUND

Resource to show one lesson

URL:

< /{idunit}/Lesson/{id} >
Method:

GET
URL Params:

idunit=[long] id=[long]
Example of query:
- URL
  
  /api/Unit/1/Lesson/1

Success response:

 {
     "id": 1,
     "name": "Lección 1 Unidad 1"
 }

Error response:

Code: 404 NOT FOUND

Change the name of the lesson

URL:

< /{idunit}/Lesson/{id} >
Method:

PUT
URL Params:

idunit=[long] id=[long]
Example of query:
- URL
  
  /api/Unit/1/Lesson/1
Data Params:
```
 {
 	"name": "Leccion Prueba"
 }
```

Success response:

 {
     "id": 1,
     "name": "Leccion Prueba"
 }

Error response:

Code: 404 NOT FOUND

To complete the lesson when all exercises are done

URL:

< /{idunit}/Lesson/{idlesson}/Completed >
Method:

GET
URL Params:

idunit=[long] idlesson=[long]
Example of query:
- URL
  
  /api/Unit/1/Lesson/1/Completed
Success response:
```
 true
```
Error response:

Code: 404 NOT FOUND

FALTA METER LA CONSULTA PARA SABER SI LA LECCIÓN ESTÁ YA COMPLETADA

Exercise

The following queries must be preceded by /Unit.

Resource to show all exercises

URL:

< /Lesson/Exercises/ >
Method:

GET
URL Params:

Empty
Example of query:
- URL
  
  api/Unit/Lesson/Exercises/

Success Response:

 {
     "totalElements": 24,
     "totalPages": 2,
     "number": 0,
     "size": 10,
     "first": true,
     "last": false,
     "content": [
 	{
 	    "id": 1,
 	    "kind": 1,
 	    "statement": "1.1.1 Seleccione el asiento",
 	    "texts": [
 		"213.Maquinaria",
 		"210.Terrenos y bienes naturales",
 		"218. Elementos de transporte"
 	    ]
 	},
 	{
 	    "id": 2,
 	    "kind": 2,
 	    "statement": "1.1.2 Escribe la denominación de la cuenta que recoge: maquinarias para el proceso productivo de la empresa",
 	    "texts": []
 	},
 	{
 	    "id": 3,
 	    "kind": 5,
 	    "statement": "1.1.5 Escoge la respuesta correcta para la cuenta: 210. Terrenos y bienes naturales",
 	    "texts": [
 		"Activo",
 		"Pasivo",
 		"Patrimonio neto"
 	    ]
 	},
 	{
 	    "id": 4,
 	    "kind": 7,
 	    "statement": "1.1.7 Escoge el enunciado correcto para el asiento: \"10 211. Construcciones a 174. Provedores de inmovilizado a l/p 10\"",
 	    "texts": [
 		" La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará integramente dentro de 10 años a través de la letra de cambio.",
 		"La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará integramente dentro de 10 años.",
 		" La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará en un plazo no superior a un año."
 	    ]
 	},
 	{
 	    "id": 5,
 	    "kind": 1,
 	    "statement": "1.1.1 Seleccione el asiento",
 	    "texts": [
 		"213.Maquinaria",
 		"210.Terrenos y bienes naturales",
 		"218. Elementos de transporte"
 	    ]
 	},
 	{
 	    "id": 6,
 	    "kind": 2,
 	    "statement": "1.2.2 Escribe la denominación de la cuenta que recoge: maquinarias para el proceso productivo de la empresa",
 	    "texts": []
 	},
 	{
 	    "id": 7,
 	    "kind": 5,
 	    "statement": "1.2.5 Escoge la respuesta correcta para la cuenta: 210. Terrenos y bienes naturales",
 	    "texts": [
 		"Activo",
 		"Pasivo",
 		"Patrimonio neto"
 	    ]
 	},
 	{
 	    "id": 8,
 	    "kind": 7,
 	    "statement": "1.2.7 Escoge el enunciado correcto para el asiento: \"10 211. Construcciones a 174. Provedores de inmovilizado a l/p 10\"",
 	    "texts": [
 		" La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará integramente dentro de 10 años a través de la letra de cambio.",
 		"La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará integramente dentro de 10 años.",
 		" La empresa compra un local por 10, dejándolo a deber a su provedor, al que pagará en un plazo no superior a un año."
 	    ]
 	},
 	{
 	    "id": 9,
 	    "kind": 1,
 	    "statement": "1.3.1 Seleccione el asiento",
 	    "texts": [
 		"213.Maquinaria",
 		"210.Terrenos y bienes naturales",
 		"218. Elementos de transporte"
 	    ]
 	},
 	{
 	    "id": 10,
 	    "kind": 2,
 	    "statement": "1.3.2 Escribe la denominación de la cuenta que recoge: maquinarias para el proceso productivo de la empresa",
 	    "texts": []
 	}
     ]
 }

Error Response:

Code: 404 NOT FOUND

Resource to show one exercise

URL:

< {idunit}/Lesson/{idlesson}/Exercise/{id} >
Method:

GET
URL Params:
- idunit=[long]
- idlesson=[long]
- id=[long]
Example of query:
- URL
  
  api/Unit/1/Lesson/1/Exercise/1

Success Response:

 {
     "id": 1,
     "kind": 1,
     "statement": "1.1.1 Seleccione el asiento",
     "texts": [
 	"213.Maquinaria",
 	"210.Terrenos y bienes naturales",
 	"218. Elementos de transporte"
     ]
 }

Error Response:

Code: 404 NOT FOUND

Change an exercise

URL:

< {idunit}/Lesson/{idlesson}/Exercise/{id} >
Method:

PUT
URL Params:
- idunit=[long]
- idlesson=[long]
- id=[long]
Example of query:
- URL
  
  api/Unit/1/Lesson/1/Exercise/1

Data Params:

 {
     "kind": 1,
     "statement": "1.1.1 Seleccione el asiento",
     "texts": [
         "213.Maquinaria",
         "210.Terrenos y bienes naturales",
         "218. Elementos de transporte"
     ]
 }

Success Response:

 {
     "id": 2,
     "kind": 1,
     "statement": "1.1.1 Seleccione el asiento",
     "texts": [
 	"213.Maquinaria",
 	"210.Terrenos y bienes naturales",
 	"218. Elementos de transporte"
     ]
 }

Error Response:

Code: 404 NOT FOUND

Resource to show an answer

URL:

< {idunit}/Lesson/{idlesson}/Exercise/{id}/Answer >
Method:

GET
URL Params:
- idunit=[long]
- idlesson=[long]
- id=[long]
Example of query:
- URL
  
  api/Unit/1/Lesson/1/Exercise/1/Answer

Success Response:

 {
     "id": 1,
     "result": "uno"
 }

Error Response:

Code: 404 NOT FOUND

Change an answer

URL:

< {idunit}/Lesson/{idlesson}/Exercise/{id}/Answer >
Method:

PUT
URL Params:
- idunit=[long]
- idlesson=[long]
- id=[long]
Example of query:
- URL
  
  api/Unit/1/Lesson/1/Exercise/1/Answer
Data Params:
```
 {
     "result": "dos"
 }
```

Success Response:

 {
     "id": 1,
     "result": "dos"
 }

Error Response:

Code: 404 NOT FOUND

Check if an answer is correct or not

URL:

< {idunit}/Lesson/{idlesson}/Exercise/{id}/Solution >
Method:

PUT
URL Params:
- idunit=[long]
- idlesson=[long]
- id=[long]
Example of query:
- URL
  
  api/Unit/1/Lesson/1/Exercise/1/Solution
Data Params:
```
 {
     "result": "dos"
 }
```
Success Response:
```
 true
```
Error Response:

Code: 404 NOT FOUND

Files

API.md

Latest commit

History

API.md

File metadata and controls

CONTaFin - API REST Documentation

About our API

How to use our API

API requests

Resources

Authentication

login

URL:

Method:

Success Response:

Error response:

loguot

URL:

Method:

Success Response:

Error Response:

Admin

Obtain user data

URL

Method:

URL Params:

Example of query:

Success Response:

Error Response:

Export data from all users

URL

Method:

Success Response:

Error Response:

Users

Resource to show a user

URL

Method:

Success respone:

Error response:

Change the name of user

URL

Método:

Data Params

Success response:

Error response:

Change the email of user

URL

Method:

Data Params

Success response:

Error response:

Change the password of user

URL

Method:

Data Params

Success response:

Error response:

Resource to update goal of user

URL

Method:

Data Params

Success response:

Error response:

Resource to upload user profile image

URL

Method:

Data Params

Error response:

Resource to delete a user

URL

Método:

Error Response:

Unit

Resource to show all units

URL:

Method:

URL Params:

Example of query: