API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Mar 31st, 2018
659
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 350.81 KB | None | 0 0
raw download clone embed print report
  1. AGETIC Bolivia hacked
  2. Super hyper lamers and n00bs LOL
  3. -----------------------------
  4. diff --git a/INSTALL.md b/INSTALL.md
  5. index eee27bf..597cd0c 100644
  6. --- a/INSTALL.md
  7. +++ b/INSTALL.md
  8. @@ -2,150 +2,246 @@ ___
  9. ## INSTALACIÓN
  10. ___
  11.  
  12. -# Prerrequisitos
  13. +Prerrequisitos
  14. +--------------
  15.  
  16. -La siguiente instalación y configuración realizado en Sistema Operativo Debian Jessie
  17. +La siguiente instalación y configuración realizado en Sistema Operativo
  18. +Debian Jessie
  19.  
  20. **Creacion de Usuario en Sistema Operativo**
  21.  
  22. -```sh
  23. -$ sudo adduser usuarioPersonal
  24. +``` {.sourceCode .sh}
  25. +$ sudo adduser usuario_proyecto
  26. ```
  27.  
  28. **Agregar Usuario al grupo sudo del Sistema Operativo**
  29.  
  30. -```sh
  31. -$ sudo adduser usuarioPersonal sudo
  32. +``` {.sourceCode .sh}
  33. +$ sudo adduser usuario_proyecto sudo
  34. ```
  35.  
  36. **Instalando GIT**
  37.  
  38. -Git (pronunciado "guit" ) es un software de control de versiones diseñado por Linus Torvalds, pensando en la eficiencia y la confiabilidad del mantenimiento de versiones de aplicaciones cuando éstas tienen un gran número de archivos de código fuente.
  39. +Git (pronunciado “guit” ) es un software de control de versiones
  40. +diseñado por Linus Torvalds, pensando en la eficiencia y la
  41. +confiabilidad del mantenimiento de versiones de aplicaciones cuando
  42. +éstas tienen un gran número de archivos de código fuente.
  43.  
  44. Para la instalación realizar:
  45. -```sh
  46. +
  47. +``` {.sourceCode .sh}
  48. $ sudo apt-get install git
  49. ```
  50.  
  51. **Instalando nodejs y npm**
  52.  
  53. ->Node.js es un entorno de desarrollo basado en JavaScript que permite la ejecución de servicios y eventos del lado del servidor. Existen múltiples librerias que podriamos incorporar a Node,js, esto lo haremos a través de su administrador NPM.
  54. +Node.js es un entorno de desarrollo basado en JavaScript que permite la
  55. +ejecución de servicios y eventos del lado del servidor. Existen
  56. +múltiples librerías que podríamos incorporar a Node,js, esto lo haremos
  57. +a través de su administrador **NPM**.
  58. +
  59. +**Instalar Curl**
  60.  
  61. ->
  62. -**Instalar Curl***
  63. +Durante el proceso de instalación necesitaremos este binario.
  64.  
  65. ->Durante el proceso de instalación necesitaremos este binario.
  66. -```sh
  67. +``` {.sourceCode .sh}
  68. $ sudo apt-get install curl
  69. ```
  70.  
  71. ->
  72. -**Añadiendo los repositorios de NodeSource***
  73. +**Añadiendo los repositorios de NodeSource**
  74.  
  75. ->Para añadir los repositorios de node.js version 4.x debemos de ejecutar:
  76. -```sh
  77. +Para añadir los repositorios de node.js version 4.x debemos de ejecutar:
  78. +
  79. +``` {.sourceCode .sh}
  80. $ sudo curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
  81. ```
  82.  
  83. ->
  84. -**Instalando Node.js***
  85. +**Instalando Node.js**
  86. +
  87. +Ahora realizaremos la instalación de node v4.4.0
  88.  
  89. ->Ahora realizaremos la instalacion de node v4.4.0
  90. -```sh
  91. +``` {.sourceCode .sh}
  92. $ sudo apt-get install -y nodejs
  93. ```
  94.  
  95. ->
  96. -**Instalando NPM***
  97. +**Instalando NPM**
  98. +
  99. +npm(node package manager) es el gestor de paquetes de Node.js, nos
  100. +permitira descargar librerias y enlazarlas.
  101. +
  102. +Antes debemos de hacer la instalación de paquetes necesarios para un
  103. +copilado correcto.
  104. +
  105. +``` {.sourceCode .sh}
  106. +$ sudo apt-get install build-essential
  107. +```
  108.  
  109. ->npm(node package manager) es el gestor de paquetes de Node.js, nos permitira descargar librerias y enlazarlas.
  110. +Debemos de seguir de la siguiente manera:
  111.  
  112. ->Debemos de seguir de la sigueinte manera:
  113. -```sh
  114. +``` {.sourceCode .sh}
  115. $ git clone http://github.com/isaacs/npm.git
  116. $ cd npm
  117. $ sudo make install
  118. ```
  119.  
  120. ->Para verificar si esta instalado correctamente:
  121. -```sh
  122. +Para verificar si esta instalado correctamente:
  123. +
  124. +``` {.sourceCode .sh}
  125. $ npm info
  126. ```
  127.  
  128. -
  129. **Instalando Gruntjs**
  130.  
  131. -Un manejador de tareas, permite minimización, compilación, pruebas unitarias, y mucho más.
  132. -```sh
  133. +Un manejador de tareas, permite minimización, compilación, pruebas
  134. +unitarias, y mucho más.
  135. +
  136. +``` {.sourceCode .sh}
  137. $ sudo npm install -g grunt-cli
  138. ```
  139. +Backend-End
  140. +===========
  141. +
  142. +**Instalando SASS**
  143. +
  144. +``` {.sourceCode .sh}
  145. +$ sudo gem install sass
  146. +```
  147.  
  148. **Instalando PostgreSQL**
  149.  
  150. -PostgreSQL es un potente sistema de base de datos objeto-relacional de código abierto.
  151. +PostgreSQL es un potente sistema de base de datos objeto-relacional de
  152. +código abierto.
  153.  
  154. -***Instalación***
  155. -```sh
  156. +- Instalación
  157. +
  158. +``` {.sourceCode .sh}
  159. $ sudo apt-get install postgresql postgresql-client postgresql-contrib
  160. ```
  161.  
  162. -***Configuración***
  163. -Para poder realizar operaciones relacionadas con PostgreSQL:
  164. ->
  165. -```sh
  166. +- Configuración
  167. +
  168. +Para poder realizar operaciones relacionadas con
  169. +
  170. +``` {.sourceCode .sql}
  171. +PostgreSQL: >
  172. $ sudo su - postgres
  173. ```
  174.  
  175. Creando usuario para el sistema:
  176. -```sqldb
  177. +
  178. +``` {.sourceCode .sql}
  179. postgres=# CREATE USER usuarioPersonal PASSWORD 'password';
  180. ```
  181.  
  182. Cambiando privilegios de usuario:
  183. -```sqlDB
  184. +
  185. +``` {.sourceCode .sql}
  186. postgres=# ALTER ROLE usuarioPersonal WITH SUPERUSER;
  187. ```
  188.  
  189. Creando la Base de Datos para el sistema
  190. -```sqldb
  191. +
  192. +``` {.sourceCode .sql}
  193. postgres=# CREATE DATABASE moduloPersonalDb WITH OWNER usuarioPersonal;
  194. ```
  195.  
  196. -## Clonar repositorio
  197. +**Clonar repositorio**
  198.  
  199. -```sh
  200. -$ sudo su - usuarioPersonal
  201. +``` {.sourceCode .sh}
  202. +$ sudo su - usuario_proyecto
  203. $ cd ~
  204. $ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonal.git
  205. $ cd ModuloPersonal
  206. ```
  207.  
  208. -Para instalar las dependecias del servidor
  209. -```sh
  210. +Para instalar las dependencias del servidor
  211. +
  212. +``` {.sourceCode .sh}
  213. +$ npm install
  214. +```
  215. +
  216. +Para iniciar el servidor de desarrollo en el puerto 9000
  217. +
  218. +``` {.sourceCode .sh}
  219. +$ grunt serve
  220. +```
  221. +
  222. +Front-End
  223. +=========
  224. +
  225. +**Instalando BOWER**
  226. +
  227. +Bower te permite administrar los componentes que contienen HTML, CSS,
  228. +JavaScript, fuentes e incluso archivos de imagen. Bower no concatenar o
  229. +minify código o hacer cualquier otra cosa - sólo instala las versiones
  230. +correctas de los paquetes que necesita y sus dependencias.
  231. +
  232. +``` {.sourceCode .sh}
  233. +$ npm install -g bower
  234. +```
  235. +
  236. +**Instalando Ruby**
  237. +
  238. +Un lenguaje de programación dinámico y de código abierto.
  239. +
  240. +``` {.sourceCode .sh}
  241. +$ sudo apt-get install ruby-full
  242. +```
  243. +
  244. +**Clonar repositorio**
  245. +
  246. +``` {.sourceCode .sh}
  247. +$ sudo su - usuarioPersonal
  248. +$ cd ~
  249. +$ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonalCliente.git
  250. +$ cd ModuloPersonal
  251. +```
  252. +
  253. +Para instalar las dependencias del servidor
  254. +
  255. +``` {.sourceCode .sh}
  256. $ npm install
  257. ```
  258.  
  259. +Para ara instalar las dependecias del cliente
  260. +
  261. +``` {.sourceCode .sh}
  262. +$ bower install
  263. +```
  264. +
  265. Para iniciar el servidor de desarrollo en el puerto 9000
  266. -```sh
  267. +
  268. +``` {.sourceCode .sh}
  269. $ grunt serve
  270. ```
  271.  
  272. -## Instalacion y configuracion de servidor NGinx
  273. +Servidor NGinx
  274. +==============
  275.  
  276. -Servidor nginx (pronunciado en inglés “engine X”) es un servidor web/proxy inverso ligero de alto rendimiento, optimizado para aplicaciones Node.js.
  277. +Servidor nginx (pronunciado en inglés “engine X”) es un servidor
  278. +web/proxy inverso ligero de alto rendimiento, optimizado para
  279. +aplicaciones Node.js.
  280.  
  281. A continuación, instalar Nginx
  282. -```sh
  283. +
  284. +``` {.sourceCode .sh}
  285. $ sudo apt-get install nginx
  286. ```
  287.  
  288. -Ahora abre el archivo de configuración del bloque servidor por defecto para la edición:
  289. -```sh
  290. +Ahora abre el archivo de configuración del bloque servidor por defecto
  291. +para la edición:
  292. +
  293. +``` {.sourceCode .sh}
  294. $ sudo nano /etc/nginx/sites-available/default
  295. ```
  296.  
  297. -Insertar la siguiente configuración. Asegúrese de sustituir su propio nombre de dominio para el server (o la dirección IP si usted no tiene un dominio configurado), y la aplicación dirección IP-Privada del servidor para el APP_PRIVATE_IP_ADDRESS . Además, cambiar el puerto ( 9000 ) si la aplicación está configurado para escuchar en un puerto diferente:
  298. -```sh
  299. +Insertar la siguiente configuración. Asegúrese de sustituir su propio
  300. +nombre de dominio para el server (o la dirección IP si usted no tiene un
  301. +dominio configurado), y la aplicación dirección IP-Privada del servidor
  302. +para el APP\_PRIVATE\_IP\_ADDRESS . Además, cambiar el puerto ( 9000 )
  303. +si la aplicación está configurado para escuchar en un puerto diferente:
  304. +
  305. +``` {.sourceCode .sh}
  306. server {
  307. listen 80;
  308.  
  309. @@ -162,10 +258,16 @@ server {
  310. }
  311. ```
  312.  
  313. -Una vez que haya terminado de añadir los bloques de localización para sus aplicaciones, guardar y salir.
  314. -En el servidor, reiniciar Nginx:
  315. -```sh
  316. +Una vez que haya terminado de añadir los bloques de localización para
  317. +sus aplicaciones, guardar y salir. En el servidor, reiniciar Nginx:
  318. +
  319. +``` {.sourceCode .sh}
  320. $ sudo /et c/init.d/nginx restart
  321. ```
  322.  
  323. -Esto configura la web del servidor para responder a las solicitudes en su raíz. Suponiendo que nuestro servidor está disponible en example.com , el acceso a http://sitio-de-prueba.gob.bo/ a través de un navegador web que enviar la solicitud a la dirección IP privada del servidor de aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js solicitud.
  324. +Esto configura la web del servidor para responder a las solicitudes en
  325. +su raíz. Suponiendo que nuestro servidor está disponible en example.com,
  326. +el acceso a <http://sitio-de-prueba.gob.bo/> a través de un navegador
  327. +web que enviar la solicitud a la dirección IP privada del servidor de
  328. +aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js
  329. +solicitud.
  330. diff --git a/README.md b/README.md
  331. index 92192e3..49e7690 100644
  332. --- a/README.md
  333. +++ b/README.md
  334. @@ -1,29 +1,56 @@
  335. -# modulo-personal
  336. +Readme
  337. +======
  338.  
  339. -Este es el modulo de personal del sistema de gestion administrativa
  340. +Este es el modulo de contratación pertenece al sistema de gestión
  341. +administrativa.
  342.  
  343. -## Desarrolladores
  344. -- D'jalmar
  345. -- David
  346. -- Gustavo
  347. +Equipo
  348. +------
  349.  
  350. -### Prerequisitos
  351. +**Programadores**
  352.  
  353. -- [Git](https://git-scm.com/)
  354. -- [Node.js and npm](nodejs.org) Node ^4.2.3, npm ^2.14.7
  355. -- [Grunt](http://gruntjs.com/) (`npm install --global grunt-cli`)
  356. -- [Postgresql](http://www.postgresql.org.es/)
  357. + * D'jalmar Gutierrez <dgutierrez@adsib.gob.bo>
  358.  
  359. -### Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes comandos en la terminal
  360. + * Teodoro Nina <tnina@adsib.gob.bo>
  361.  
  362. -1. Ejecutar `npm install` para instalar las dependecias del servidor.
  363.  
  364. -2. Ejecutar `grunt serve` para iniciar el servidor de desarrollo. Debe iniciar automaticamente el explorador.
  365. +**Pasante**
  366.  
  367. -## Compilacion y desarrollo
  368. + * Gustavo Callejas <gcallejas@adsib.gob.bo>
  369.  
  370. -Ejecutar `grunt build` para compilar el proyecto, el proyecto compilado se encuentra en la carpeta `dist` luego ejecutar `grunt serve` para una vista previa.
  371.  
  372. -## Tests
  373. +Prerequisitos
  374. +-------------
  375.  
  376. -Ejecutar `npm test` para ejecutar todos los test(unitarios y de integracion) del proyecto
  377. +- [Git]
  378. +- [Node.js and npm] Node \^4.2.3, npm \^2.14.7
  379. +- [Grunt] (`npm install --global grunt-cli`)
  380. +- [Postgresql]
  381. +
  382. +Ejecución
  383. +---------
  384. +
  385. +Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes
  386. +comandos en la terminal
  387. +
  388. +1. Ejecutar `npm install` para instalar las dependecias del servidor.
  389. +2. Ejecutar `grunt serve` para iniciar el servidor de desarrollo. Debe
  390. + iniciar automaticamente el explorador.
  391. +
  392. +Compilación y Desarrollo
  393. +------------------------
  394. +
  395. +Ejecutar `grunt build` para compilar el proyecto, y el resultado de esa
  396. +compilación se encuentra en la carpeta `dist` luego ejecutar **grunt
  397. +serve** para una vista previa.
  398. +
  399. +Test
  400. +----
  401. +
  402. +Ejecutar `npm test` para ejecutar todos los test(unitarios y de
  403. +integración) del proyecto
  404. +
  405. + [Git]: https://git-scm.com/
  406. + [Node.js and npm]: nodejs.org
  407. + [Grunt]: http://gruntjs.com/
  408. + [Postgresql]: http://www.postgresql.org.es/
  409. diff --git a/docs/autenticacion/autenticacion.rst b/docs/autenticacion/autenticacion.rst
  410. index e8a3dfd..e925693 100644
  411. --- a/docs/autenticacion/autenticacion.rst
  412. +++ b/docs/autenticacion/autenticacion.rst
  413. @@ -1,63 +1,59 @@
  414. Autenticación de usuario
  415. ========================
  416.  
  417. -URL
  418. ----
  419. -::
  420. +Formato URL
  421. +------------------------
  422. ++-----------------+-------------------------+
  423. +|**Método HTTP** |**Significado** |
  424. ++=================+=========================+
  425. +|`POST` | Crea un recurso |
  426. ++-----------------+-------------------------+
  427.  
  428. - /autenticar/ldap
  429. +Parámetros
  430. +------------------------
  431.  
  432. -Método
  433. -------
  434. -``POST``
  435. -
  436. -Parámetros del body
  437. --------------------
  438. +**body**
  439.  
  440. .. code:: json
  441.  
  442. {
  443. "nombreUsuario": "test",
  444. - "contrasena": "123456"
  445. + "contrasena": "password"
  446. }
  447.  
  448. -Respuesta correcta
  449. -------------------
  450. -
  451. -**Código:** 200
  452. -
  453. -**Contenido:**
  454.  
  455. -.. code:: json
  456.  
  457. - {
  458. - "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiJ0ZXN0IiwiY29ycmVvIjoidGVzdEBnbWFpbC5jb20iLCJub21icmVDb21wbGV0byI6IlRlc3QgR3V0aWVycmV6Iiwicm9sZXMiOlsiQURNSU5JU1RSQVRPUiJdLCJpYXQiOjE0NjAxMjQ2MTQsImV4cCI6MTQ2MDE0MjYxNH0.fZ401WElQgKmASLxV_vFaR2YfVJIapTbqBJeIsOxjbw"
  459. - }
  460. +Respuestas
  461. +----------
  462.  
  463. -Respuesta incorrecta
  464. ---------------------
  465. -
  466. -**Código:** 400
  467. -
  468. -**Contenido**
  469. +**Token**
  470.  
  471. .. code:: json
  472.  
  473. {
  474. - "message": "Invalid username/password"
  475. + "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1Ni10.eyJfaWQiOiJ0ZXN0IiwiY29ycmVvIjoidGVzdEBnbWFpbC5jb20iLCJub21icmVDb21wbGV0byI6IlRlc3QgR3V0aWDaViD6Iiwicm9sZXMiOlsiQURNSU5JU1RSQVRPUiJdLCJpYXQiOjE0NjAxMjQ2MTQsImV4cCI6MTQ2MDE0MjYxNH0.fZ401WElQgKmASLxV_vFaR2YfVJIapTbqBJeIsOxjbw"
  476. }
  477.  
  478. -**Código:** 404
  479. -
  480. -**Contenido**
  481. -
  482. -.. code:: json
  483. ++------------------+----------------------------------------------------------------------------------------------+
  484. +| **Código HTTP** | **Descripción** |
  485. ++==================+==============================================================================================+
  486. +| `200` | Ok |
  487. ++------------------+----------------------------------------------------------------------------------------------+
  488. +| `201` | Creado |
  489. ++------------------+----------------------------------------------------------------------------------------------+
  490. +| `400` | Parámetros incorrectos en la entrada |
  491. ++------------------+----------------------------------------------------------------------------------------------+
  492. +| `401` | Token de acceso expirado o invalido |
  493. ++------------------+----------------------------------------------------------------------------------------------+
  494. +| `404` | Recurso no encontrado |
  495. ++------------------+----------------------------------------------------------------------------------------------+
  496. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  497. ++------------------+----------------------------------------------------------------------------------------------+
  498. +| `500` | Error interno del servidor |
  499. ++------------------+----------------------------------------------------------------------------------------------+
  500.  
  501. - {
  502. - "message": "Missing credentials"
  503. - }
  504.  
  505. Observaciones
  506. -------------
  507.  
  508. -- Se debe añadir el token en todas las peticiones de la API
  509. +- Se debe añadir el token en todas las peticiones de la API.
  510. diff --git a/docs/cambios/cambios.rst b/docs/cambios/cambios.rst
  511. deleted file mode 100644
  512. index 38e3b85..0000000
  513. --- a/docs/cambios/cambios.rst
  514. +++ /dev/null
  515. @@ -1,7 +0,0 @@
  516. -Cambios
  517. -==============
  518. -
  519. -Versiones
  520. ----------
  521. -
  522. -Listado de los cambios del proyecto Modulo Personal
  523. diff --git a/docs/cargo/cargo.rst b/docs/cargo/cargo.rst
  524. index 48171d2..4119cf6 100644
  525. --- a/docs/cargo/cargo.rst
  526. +++ b/docs/cargo/cargo.rst
  527. @@ -32,21 +32,25 @@ Contenido en data del cuerpo para realizar el creado y actualización de un regi
  528. }
  529.  
  530.  
  531. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  532. -|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  533. -+========================================+=====================================================================================================+====================================================+=====================================================+==============================================+
  534. -| `/cargos` | Obtiene el listado de todos los cargos | Crea un registro de cargo | | |
  535. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  536. -| `/cargos/:id` | Obtiene el cargo identificado como :id | | Actualiza el cargo identificado como :id | Elimina el cargo identificado como :id |
  537. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  538. -| `/cargos/asignados` | Obtiene el listado de todos los cargos asignados | | | |
  539. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  540. -| `/cargos/disponibles` | Obtiene el listado de los cargos disponibles | | | |
  541. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  542. -| `/cargos/:id/convocatoria` | Obtiene el listado de las convocatoria asociadas al cargo identificado como :id | | | |
  543. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  544. -| `/cargos/:id/relacionesLaborales` | Obtiene el listado de las personas con relacion laboral asociadas al cargo identificado como :id | | | |
  545. -+----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  546. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  547. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  548. ++========================================+=====================================================================================================+====================================================+=============================================================================+==============================================+
  549. +| `/cargos` | Obtiene el listado de todos los cargos | Crea un registro de cargo | | |
  550. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  551. +| `/cargos/:id` | Obtiene el cargo identificado como :id | | Actualiza el cargo identificado como :id | Elimina el cargo identificado como :id |
  552. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  553. +| `/cargos/asignados` | Obtiene el listado de todos los cargos asignados | | | |
  554. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  555. +| `/cargos/disponibles` | Obtiene el listado de los cargos disponibles | | | |
  556. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  557. +| `/cargos/:id/convocatoria` | Obtiene el listado de las convocatoria asociadas al cargo identificado como :id | | | |
  558. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  559. +| `/cargos/:id/relacionesLaborales` | Obtiene el listado de las personas con relacion laboral asociadas al cargo identificado como :id | | | |
  560. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  561. +| `/cargos/:id/ordenarCargos` | | | Actualiza `orden` en los registros asociadas al cargo identificado como :id | |
  562. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  563. +| `/cargos/:id/asignaOrdenCargos` | | | Actualiza `orden` reasignando asociadas al cargo identificado como :id | |
  564. ++----------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------------------------------+----------------------------------------------+
  565.  
  566.  
  567. Tabla de parámetros opcionales de la URL para peticines GET
  568. diff --git a/docs/comentario/comentario.rst b/docs/comentario/comentario.rst
  569. index 4e394fa..4148c15 100644
  570. --- a/docs/comentario/comentario.rst
  571. +++ b/docs/comentario/comentario.rst
  572. @@ -1,59 +1,48 @@
  573. Comentario
  574. -==========
  575. -
  576. -Mostrar todos los comentarios
  577. ------------------------------
  578. -
  579. -URL
  580. -```
  581. -::
  582. -
  583. - /comentarios
  584. -
  585. -Método
  586. -``````
  587. -``GET``
  588. -
  589. -Respuesta correcta
  590. -``````````````````
  591. -
  592. -**Código:** 200
  593. -
  594. -**Contenido:**
  595. -
  596. -.. code:: json
  597. -
  598. - {
  599. - "count":3,"rows":
  600. - [
  601. - {
  602. - "_id": 178,
  603. - "contenido": "¿A qué hora es el examen?",
  604. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  605. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  606. - "fk_persona": 241
  607. - },
  608. - {
  609. - "_id": 179,
  610. - "contenido": "¿Es necesario llevar carnet?",
  611. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  612. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  613. - "fk_persona": 241
  614. - },
  615. - {
  616. - "_id": 180,
  617. - "contenido": "¿Por qué se postergo el examen?",
  618. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  619. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  620. - "fk_persona": 242
  621. - }
  622. - ]
  623. - }
  624. -
  625. -Parámetros opcionales de la URL
  626. -```````````````````````````````
  627. -Tabla de parámetros
  628. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  629. +====================
  630. +
  631. +Formato URL
  632. +------------------------
  633. ++-----------------+-------------------------+
  634. +|**Método HTTP** |**Significado** |
  635. ++=================+=========================+
  636. +|`GET` | Obtiene un recurso |
  637. ++-----------------+-------------------------+
  638. +|`POST` | Crea un recurso |
  639. ++-----------------+-------------------------+
  640. +|`PUT` | Actualiza un recurso |
  641. ++-----------------+-------------------------+
  642. +|`DELETE` | Borra un recurso |
  643. ++-----------------+-------------------------+
  644. +
  645. +Ejemplo
  646. +''''''''''''
  647. +
  648. +**Contenido Body**
  649. +
  650. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  651. +
  652. +.. code:: json
  653. +
  654. + {
  655. + "contenido": "Cumple con los requisitos para el puesto, listo para iniciar."",
  656. + "fecha_creacion": "2016-07-26 10:37:08.885-04",
  657. + "fecha_modificacion": "2016-07-26 10:37:08.885-04",
  658. + "fk_persona": 1202, //Persona: Jesus Adrian Romero
  659. + "fk_usuario": 1 //Usuario: Test
  660. + }
  661. +
  662. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  663. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  664. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  665. +| /comentarios | Obtiene el listado de todos los comentarios | Crea un registro de comentario | | |
  666. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  667. +| /comentarios/:id | Obtiene el comentario identificado como :id | | Actualiza registro :id de comentario | Elimina registro :id de comentario |
  668. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  669. +
  670. +
  671. +Tabla de parámetros opcionales de la URL para peticines GET
  672. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  673. +-+-----------+------------------+---------------------------------------------------------------------+
  674. |**Nombre** |**Tipo** |**Descripción** |
  675. +=+===========+==================+=====================================================================+
  676. @@ -78,772 +67,25 @@ Tabla de parámetros
  677. | |`entidad` | String |El nombre de la entidad. |
  678. +-+-----------+------------------+---------------------------------------------------------------------+
  679.  
  680. -Muestra una determinada cantidad de comentarios
  681. -'''''''''''''''''''''''''''''''''''''''''''''''
  682. -
  683. -**URL**
  684. -::
  685. -
  686. - /comentarios?elementos=valor
  687. -
  688. -**Parámetros usados**
  689. -
  690. -============ =====================
  691. -**Nombre** **Valor enviado**
  692. -============ =====================
  693. -`elementos` 1
  694. -============ =====================
  695. -
  696. -**Ejemplo:**
  697. -::
  698. -
  699. - /comentarios?elementos=2
  700. -
  701. -**Respuesta:**
  702. -
  703. -.. code:: json
  704. -
  705. - {
  706. - "count":3,"rows":
  707. - [
  708. - {
  709. - "_id": 178,
  710. - "contenido": "¿A qué hora es el examen?",
  711. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  712. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  713. - "fk_persona": 241
  714. - },
  715. - {
  716. - "_id": 179,
  717. - "contenido": "¿Es necesario llevar carnet?",
  718. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  719. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  720. - "fk_persona": 241
  721. - }
  722. - ]
  723. - }
  724. -
  725. -Muestra los comentarios en una determinada página
  726. -'''''''''''''''''''''''''''''''''''''''''''''''''
  727. -
  728. -**URL**
  729. -::
  730. -
  731. - /comentarios?pagina=valor
  732. -
  733. -**Parámetros usados**
  734. -
  735. -============ =====================
  736. -**Nombre** **Valor enviado**
  737. -============ =====================
  738. -`pagina` 1
  739. -============ =====================
  740. -
  741. -**Ejemplo:**
  742. -::
  743. -
  744. - /comentarios?pagina=1
  745. -
  746. -**Respuesta:**
  747. -
  748. -.. code:: json
  749. -
  750. - {
  751. - "count":3,"rows":
  752. - [
  753. - {
  754. - "_id": 178,
  755. - "contenido": "¿A qué hora es el examen?",
  756. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  757. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  758. - "fk_persona": 241
  759. - },
  760. - {
  761. - "_id": 179,
  762. - "contenido": "¿Es necesario llevar carnet?",
  763. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  764. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  765. - "fk_persona": 241
  766. - },
  767. - {
  768. - "_id": 180,
  769. - "contenido": "¿Por qué se postergo el examen?",
  770. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  771. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  772. - "fk_persona": 242
  773. - }
  774. - ]
  775. - }
  776. -
  777. -Ordena los comentarios ascendentemente en base a un campo del modelo
  778. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  779. -
  780. -**URL**
  781. -::
  782. -
  783. - /comentarios?ordenarPor=valor
  784. -
  785. -**Parámetros usados**
  786. -
  787. -============ =====================
  788. -**Nombre** **Valor enviado**
  789. -============ =====================
  790. -`ordenarPor` contenido
  791. -============ =====================
  792. -
  793. -**Ejemplo:**
  794. -::
  795. -
  796. - /comentarios?ordenarPor=contenido
  797. -
  798. -**Respuesta:**
  799. -
  800. -.. code:: json
  801. -
  802. - {
  803. - "count":3,"rows":
  804. - [
  805. - {
  806. - "_id": 178,
  807. - "contenido": "¿A qué hora es el examen?",
  808. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  809. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  810. - "fk_persona": 241
  811. - },
  812. - {
  813. - "_id": 179,
  814. - "contenido": "¿Es necesario llevar carnet?",
  815. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  816. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  817. - "fk_persona": 241
  818. - },
  819. - {
  820. - "_id": 180,
  821. - "contenido": "¿Por qué se postergo el examen?",
  822. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  823. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  824. - "fk_persona": 242
  825. - }
  826. - ]
  827. - }
  828. -
  829. -Ordena los comentarios descendentemente en base a un campo del modelo
  830. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  831. -
  832. -**URL**
  833. -::
  834. -
  835. - /comentarios?ordenarPor=valor1&orden=true
  836. -
  837. -**Parámetros usados**
  838. -
  839. -============ =================
  840. -**Nombre** **Valor enviado**
  841. -============ =================
  842. -`ordenarPor` contenido
  843. -`orden` true
  844. -============ =================
  845. -
  846. -**Ejemplo:**
  847. -::
  848. -
  849. - /comentarios?ordenarPor=contenido&orden=true
  850. -
  851. -**Respuesta:**
  852. -
  853. -.. code:: json
  854. -
  855. - {
  856. - "count":3,"rows":
  857. - [
  858. - {
  859. - "_id": 180,
  860. - "contenido": "¿Por qué se postergo el examen?",
  861. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  862. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  863. - "fk_persona": 242
  864. - },
  865. - {
  866. - "_id": 179,
  867. - "contenido": "¿Es necesario llevar carnet?",
  868. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  869. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  870. - "fk_persona": 241
  871. - },
  872. - {
  873. - "_id": 178,
  874. - "contenido": "¿A qué hora es el examen?",
  875. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  876. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  877. - "fk_persona": 241
  878. - }
  879. - ]
  880. - }
  881. -
  882. -Busca los comentarios que contenga la palabra "postergo" en el campo "contenido"
  883. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  884. -
  885. -**URL**
  886. -::
  887. -
  888. - /comentarios?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  889. -
  890. -**Parámetros usados**
  891. -
  892. -============ ===========================================
  893. -**Nombre** **Valor enviado**
  894. -============ ===========================================
  895. -`buscar` ::
  896. -
  897. - [{"en":"contenido","palabra":"postergo"}]
  898. -============ ===========================================
  899. -
  900. -**Ejemplo:**
  901. -::
  902. -
  903. - /comentarios?buscar=%7B%22en%22:%22contenido%22,%22palabra%22:%22postergo%22%7D
  904. -
  905. -**Respuesta:**
  906. -
  907. -.. code:: json
  908. -
  909. - {
  910. - "count":3,"rows":
  911. - [
  912. - {
  913. - "_id": 180,
  914. - "contenido": "¿Por qué se postergo el examen?",
  915. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  916. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  917. - "fk_persona": 242
  918. - }
  919. - ]
  920. - }
  921. -
  922. -Muestra los postulantes de cada comentario
  923. -''''''''''''''''''''''''''''''''''''''''''
  924. -
  925. -**URL**
  926. -::
  927. -
  928. - /comentarios?incluye=%7B%22entidad%22:%22valor1%22%7D
  929. -
  930. -**Parámetros usados**
  931. -
  932. -============ ===========================================
  933. -**Nombre** **Valor enviado**
  934. -============ ===========================================
  935. -`incluye` ::
  936. -
  937. - [{"entidad":"Persona"}]
  938. -============ ===========================================
  939. -
  940. -**Ejemplo:**
  941. -::
  942. -
  943. - /comentarios?incluye=%7B%22entidad%22:%22Persona%22%7D
  944. -
  945. -**Respuesta:**
  946. -
  947. -.. code:: json
  948. -
  949. - {
  950. - "count":3,"rows":
  951. - [
  952. - {
  953. - "_id": 178,
  954. - "contenido": "¿A qué hora es el examen?",
  955. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  956. - "fecha_modificacion": "2016-03-16T15:40:22.265Z",
  957. - "fk_persona": 241,
  958. - "Persona":
  959. - {
  960. - "_id": 241,
  961. - "nombres": "Hugo Juan",
  962. - "apellidos": "Layme Pereida",
  963. - "ci": 372348,
  964. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  965. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  966. - }
  967. - },
  968. - {
  969. - "_id": 179,
  970. - "contenido": "¿Es necesario llevar carnet?",
  971. - "fecha_creacion": "2016-03-16T15:40:22.266Z",
  972. - "fecha_modificacion": "2016-03-16T15:40:22.266Z",
  973. - "fk_persona": 241,
  974. - "Persona":
  975. - {
  976. - "_id": 241,
  977. - "nombres": "Hugo Juan",
  978. - "apellidos": "Layme Pereida",
  979. - "ci": 372348,
  980. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  981. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  982. - }
  983. - },
  984. - {
  985. - "_id": 180,
  986. - "contenido": "¿Por qué se postergo el examen?",
  987. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  988. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  989. - "fk_persona": 242,
  990. - "Persona":
  991. - {
  992. - "_id": 242,
  993. - "nombres": "Juan Pablo",
  994. - "apellidos": "Oropeza Velez",
  995. - "ci": 233232,
  996. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  997. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  998. - }
  999. - }
  1000. - ]
  1001. - }
  1002. -
  1003. -Respuesta de error
  1004. -``````````````````
  1005. -
  1006. -**Código:** 500
  1007. -
  1008. -**Contenido:**
  1009. -
  1010. -.. code:: json
  1011. -
  1012. - {
  1013. - "error":"Ocurrio un problema inesperado en el servidor"
  1014. - }
  1015. -
  1016. -Observaciones
  1017. -`````````````
  1018. -- Cuando no existen datos almacenados en la base de datos retorna un array vacio
  1019. -- El parámetro 'orden' depende de 'ordenarPor'
  1020. -- El parámetro 'pagina' muestra 15 comentarios por defecto
  1021. -
  1022. -----
  1023. -
  1024. -Crear un comentario
  1025. --------------------
  1026. -
  1027. -URL
  1028. -```
  1029. -::
  1030. -
  1031. - /comentarios
  1032. -
  1033. -Método
  1034. -``````
  1035. -``POST``
  1036. -
  1037. -Parámetros del body
  1038. -```````````````````
  1039. -**Ejemplo:**
  1040. -
  1041. -.. code:: json
  1042. -
  1043. - {
  1044. - "contenido": "comentario de prueba",
  1045. - "fk_persona":241
  1046. - }
  1047. -
  1048. -Respuesta correcta
  1049. -``````````````````
  1050. -
  1051. -**Código:** 201
  1052. -
  1053. -**Contenido:**
  1054. -
  1055. -.. code:: json
  1056. -
  1057. - {
  1058. - "_id": 189,
  1059. - "contenido": "comentario de prueba",
  1060. - "fk_persona": 241,
  1061. - "fecha_modificacion": "2016-03-16T15:47:04.495Z",
  1062. - "fecha_creacion": "2016-03-16T15:47:04.495Z"
  1063. - }
  1064. -
  1065. -
  1066. -Respuesta de error
  1067. -``````````````````
  1068. -
  1069. -**Código:** 400
  1070. -
  1071. -**Contenido:**
  1072. -
  1073. -.. code:: json
  1074. -
  1075. - {
  1076. - "name": "SequelizeValidationError",
  1077. - "message": "Validation error: Por favor ingrese un comentario",
  1078. - "errors": [
  1079. - {
  1080. - "message": "Por favor ingrese un comentario",
  1081. - "type": "Validation error",
  1082. - "path": "contenido",
  1083. - "value": {},
  1084. - "__raw": {}
  1085. - }
  1086. - ]
  1087. - }
  1088. -
  1089. -----
  1090. -
  1091. -Mostrar un comentario
  1092. ----------------------
  1093. -
  1094. -URL
  1095. -```
  1096. -::
  1097. -
  1098. - /cargos/:id
  1099. -
  1100. -Método
  1101. -``````
  1102. -``GET``
  1103. -
  1104. -Parámetros de la URL
  1105. -````````````````````
  1106. -
  1107. -**Parámetro requerido:**
  1108. -
  1109. -============ ============== ================================================
  1110. -**Nombre** **Tipo** **Descripción**
  1111. -============ ============== ================================================
  1112. -`id` Integer Identificador único del registro en la entidad.
  1113. -============ ============== ================================================
  1114. -
  1115. -**Ejemplo:**
  1116. -::
  1117. -
  1118. - id=180
  1119. -
  1120. -Respuesta correcta
  1121. -``````````````````
  1122. -
  1123. -**Código:** 200
  1124. -
  1125. -**Contenido:**
  1126. -
  1127. -.. code:: json
  1128. -
  1129. - {
  1130. - "_id": 180,
  1131. - "contenido": "¿Por qué se postergo el examen?",
  1132. - "fecha_creacion": "2016-03-16T15:40:22.267Z",
  1133. - "fecha_modificacion": "2016-03-16T15:40:22.267Z",
  1134. - "fk_persona": 242
  1135. - }
  1136. -
  1137. -Respuesta de error
  1138. -``````````````````
  1139. -
  1140. -**Código:** 404
  1141. -
  1142. -**Contenido:**
  1143. -
  1144. -.. code:: json
  1145. -
  1146. - {
  1147. - "message": "Entidad no encontrada"
  1148. - }
  1149. -
  1150. -----
  1151. -
  1152. -Editar un comentario
  1153. ---------------------
  1154. -
  1155. -URL
  1156. -```
  1157. -::
  1158. -
  1159. - /comentarios/:id
  1160. -
  1161. -Método
  1162. -``````
  1163. -``PUT``
  1164. -
  1165. -Parámetros de la URL
  1166. -````````````````````
  1167. -
  1168. -**Parámetro requerido:**
  1169. -
  1170. -============ ============== ================================================
  1171. -**Nombre** **Tipo** **Descripción**
  1172. -============ ============== ================================================
  1173. -`id` Integer Identificador único del registro en la entidad.
  1174. -============ ============== ================================================
  1175. -
  1176. -**Ejemplo:**
  1177. -::
  1178. -
  1179. - id=83
  1180. -
  1181. -Parámetros del body
  1182. -```````````````````
  1183. -**Ejemplo:**
  1184. -
  1185. -.. code:: json
  1186. -
  1187. - {
  1188. - "contenido": "Comentario modificado",
  1189. - "fk_persona": 241
  1190. - }
  1191. -
  1192. -Respuesta correcta
  1193. -``````````````````
  1194. -
  1195. -**Código:** 200
  1196. -
  1197. -**Contenido:**
  1198. -
  1199. -.. code:: json
  1200. -
  1201. - {
  1202. - "_id": 83,
  1203. - "contenido": "Comentario modificado",
  1204. - "fecha_creacion": "2016-03-16T15:40:22.265Z",
  1205. - "fecha_modificacion": "2016-03-16T15:48:49.656Z",
  1206. - "fk_persona": 241
  1207. - }
  1208. -
  1209. -Respuesta de error
  1210. -``````````````````
  1211. -
  1212. -**Código:** 404
  1213. -
  1214. -**Contenido:**
  1215. -
  1216. -.. code:: json
  1217. -
  1218. - {
  1219. - "message": "Entidad no encontrada"
  1220. - }
  1221. -
  1222. -
  1223. -**Código:** 400
  1224. -
  1225. -**Contenido:**
  1226. -
  1227. -.. code:: json
  1228. -
  1229. - {
  1230. - "name": "SequelizeValidationError",
  1231. - "message": "Validation error: Por favor ingrese un comentario",
  1232. - "errors": [
  1233. - {
  1234. - "message": "Por favor ingrese un comentario",
  1235. - "type": "Validation error",
  1236. - "path": "contenido",
  1237. - "value": {},
  1238. - "__raw": {}
  1239. - }
  1240. - ]
  1241. - }
  1242. -
  1243. -----
  1244. -
  1245. -Eliminar un comentario
  1246. -----------------------
  1247. -
  1248. -URL
  1249. -```
  1250. -::
  1251. -
  1252. - /comentarios/:id
  1253. -
  1254. -Método
  1255. -``````
  1256. -``DELETE``
  1257. -
  1258. -Parámetros de la URL
  1259. -````````````````````
  1260. -
  1261. -**Parámetro requerido:**
  1262. -
  1263. -============ ============== ================================================
  1264. -**Nombre** **Tipo** **Descripción**
  1265. -============ ============== ================================================
  1266. -`id` Integer Identificador único del registro en la entidad.
  1267. -============ ============== ================================================
  1268. -
  1269. -**Ejemplo:**
  1270. -::
  1271. -
  1272. - id=83
  1273. -
  1274. -Respuesta correcta
  1275. -``````````````````
  1276. -
  1277. -**Código:** 204
  1278. -
  1279. -Respuesta de error
  1280. -``````````````````
  1281. -
  1282. -**Código:** 404
  1283. -
  1284. -**Contenido:**
  1285. -
  1286. -.. code:: json
  1287. -
  1288. - {
  1289. - "message": "Entidad no encontrada"
  1290. - }
  1291. -
  1292. -----
  1293. -
  1294. -Mostrar todos los comentarios de un postulante
  1295. -----------------------------------------------
  1296. -
  1297. -URL
  1298. -```
  1299. -::
  1300. -
  1301. - /comentarios/postulante/:id
  1302. -
  1303. -Método
  1304. -``````
  1305. -``GET``
  1306. -
  1307. -Parámetros de la URL
  1308. -````````````````````
  1309. -
  1310. -**Parámetro requerido:**
  1311. -
  1312. -============ ============== ================================================
  1313. -**Nombre** **Tipo** **Descripción**
  1314. -============ ============== ================================================
  1315. -`id` Integer Identificador único del registro en la entidad.
  1316. -============ ============== ================================================
  1317. -
  1318. -**Ejemplo:**
  1319. -::
  1320. -
  1321. - id=83
  1322. -
  1323. -Respuesta correcta
  1324. -``````````````````
  1325. -
  1326. -**Código:** 200
  1327. -
  1328. -**Contenido:**
  1329. -
  1330. -.. code:: json
  1331. -
  1332. - [
  1333. - {
  1334. - "_id": 190,
  1335. - "contenido": "¿A qué hora es el examen?",
  1336. - "fecha_creacion": "2016-03-16T15:50:28.624Z",
  1337. - "fecha_modificacion": "2016-03-16T15:50:28.624Z",
  1338. - "fk_persona": 246
  1339. - },
  1340. - {
  1341. - "_id": 191,
  1342. - "contenido": "¿Es necesario llevar carnet?",
  1343. - "fecha_creacion": "2016-03-16T15:50:28.625Z",
  1344. - "fecha_modificacion": "2016-03-16T15:50:28.625Z",
  1345. - "fk_persona": 246
  1346. - }
  1347. - ]
  1348. -
  1349. -Respuesta de error
  1350. -``````````````````
  1351. -
  1352. -**Código:** 404
  1353. -
  1354. -**Contenido:**
  1355. -
  1356. -.. code:: json
  1357. -
  1358. - {
  1359. - "message": "Entidad no encontrada"
  1360. - }
  1361. -
  1362. -----
  1363. -
  1364. -Mostrar todos los postulantes a un cargo
  1365. -----------------------------------------
  1366. -
  1367. -URL
  1368. -```
  1369. -::
  1370. -
  1371. - /postulaciones/cargo/:id
  1372. -
  1373. -Método
  1374. -``````
  1375. -``GET``
  1376. -
  1377. -Parámetros de la URL
  1378. -````````````````````
  1379. -
  1380. -**Parámetro requerido:**
  1381. -
  1382. -============ ============== ================================================
  1383. -**Nombre** **Tipo** **Descripción**
  1384. -============ ============== ================================================
  1385. -`id` Integer Identificador único del registro en la entidad.
  1386. -============ ============== ================================================
  1387. -
  1388. -**Ejemplo:**
  1389. -::
  1390. -
  1391. - id=286
  1392. -
  1393. -Respuesta correcta
  1394. -``````````````````
  1395. -
  1396. -**Código:** 200
  1397. -
  1398. -**Contenido:**
  1399. -
  1400. -.. code:: json
  1401. -
  1402. - [
  1403. - {
  1404. - "_id": 241,
  1405. - "nombres": "Juan Carlos",
  1406. - "apellidos": "Perez Gomez",
  1407. - "ci": "6867562",
  1408. - "fecha_creacion": "2016-03-16T15:40:22.195Z",
  1409. - "fecha_modificacion": "2016-03-16T15:40:22.195Z",
  1410. - "Postulacion": {
  1411. - "_id": 28,
  1412. - "presentacion": "Texto de presentacion1",
  1413. - "fecha_creacion": "2016-03-16T15:40:22.382Z",
  1414. - "fecha_modificacion": "2016-03-16T15:40:22.382Z",
  1415. - "fk_persona": 241,
  1416. - "fk_cargo": 286
  1417. - }
  1418. - },
  1419. - {
  1420. - "_id": 242,
  1421. - "nombres": "Ana Pamela",
  1422. - "apellidos": "Rodriguez",
  1423. - "ci": "6867122",
  1424. - "fecha_creacion": "2016-03-16T15:40:22.195Z",
  1425. - "fecha_modificacion": "2016-03-16T15:40:22.195Z",
  1426. - "Postulacion": {
  1427. - "_id": 29,
  1428. - "presentacion": "Texto de presentacion1",
  1429. - "fecha_creacion": "2016-03-16T15:40:22.382Z",
  1430. - "fecha_modificacion": "2016-03-16T15:40:22.382Z",
  1431. - "fk_persona": 242,
  1432. - "fk_cargo": 286
  1433. - }
  1434. - }
  1435. - ]
  1436. -
  1437. -Respuesta de error
  1438. -``````````````````
  1439. -
  1440. -**Código:** 404
  1441. -
  1442. -**Contenido:**
  1443. -
  1444. -.. code:: json
  1445. -
  1446. - {
  1447. - "message": "Entidad no encontrada"
  1448. - }
  1449. +Respuestas
  1450. +----------
  1451. +
  1452. ++------------------+----------------------------------------------------------------------------------------------+
  1453. +| **Código HTTP** | **Descripción** |
  1454. ++==================+==============================================================================================+
  1455. +| `200` | Ok |
  1456. ++------------------+----------------------------------------------------------------------------------------------+
  1457. +| `201` | Creado |
  1458. ++------------------+----------------------------------------------------------------------------------------------+
  1459. +| `400` | Parámetros incorrectos en la entrada |
  1460. ++------------------+----------------------------------------------------------------------------------------------+
  1461. +| `401` | Token de acceso expirado o invalido |
  1462. ++------------------+----------------------------------------------------------------------------------------------+
  1463. +| `404` | Recurso no encontrado |
  1464. ++------------------+----------------------------------------------------------------------------------------------+
  1465. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  1466. ++------------------+----------------------------------------------------------------------------------------------+
  1467. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  1468. ++------------------+----------------------------------------------------------------------------------------------+
  1469. +| `500` | Error interno del servidor |
  1470. ++------------------+----------------------------------------------------------------------------------------------+
  1471. diff --git a/docs/contratacion/contratacion.rst b/docs/contratacion/contratacion.rst
  1472. index 664d09b..4fd9325 100644
  1473. --- a/docs/contratacion/contratacion.rst
  1474. +++ b/docs/contratacion/contratacion.rst
  1475. @@ -1,68 +1,49 @@
  1476. Contratación
  1477. -============
  1478. +====================
  1479.  
  1480. -Mostrar todas las contrataciones
  1481. ---------------------------------
  1482. -
  1483. -URL
  1484. -```
  1485. -::
  1486. -
  1487. - /contrataciones
  1488. -
  1489. -Método
  1490. -``````
  1491. -``GET``
  1492. -
  1493. -Respuesta correcta
  1494. -``````````````````
  1495. -
  1496. -**Código:** 200
  1497. -
  1498. -**Contenido:**
  1499. -
  1500. -.. code:: json
  1501. -
  1502. - {
  1503. - "count": 3,
  1504. - "rows": [
  1505. - {
  1506. - "_id": 1,
  1507. - "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1508. - "estado": true,
  1509. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1510. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1511. - "fk_persona": 1,
  1512. - "fk_cargo": 1,
  1513. - "fk_tipo_contrato": 1
  1514. - },
  1515. - {
  1516. - "_id": 2,
  1517. - "fechaContratacion": "2000-08-12T20:58:20.042Z",
  1518. - "estado": true,
  1519. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1520. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1521. - "fk_persona": 2,
  1522. - "fk_cargo": 3,
  1523. - "fk_tipo_contrato": 3
  1524. - },
  1525. - {
  1526. - "_id": 3,
  1527. - "fechaContratacion": "2005-01-15T20:58:20.042Z",
  1528. - "estado": true,
  1529. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1530. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1531. - "fk_persona": 3,
  1532. - "fk_cargo": 4,
  1533. - "fk_tipo_contrato": 3
  1534. - }
  1535. - ]
  1536. - }
  1537. -
  1538. -Parámetros opcionales de la URL
  1539. -```````````````````````````````
  1540. -Tabla de parámetros
  1541. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  1542. +Formato URL
  1543. +------------------------
  1544. ++-----------------+-------------------------+
  1545. +|**Método HTTP** |**Significado** |
  1546. ++=================+=========================+
  1547. +|`GET` | Obtiene un recurso |
  1548. ++-----------------+-------------------------+
  1549. +|`POST` | Crea un recurso |
  1550. ++-----------------+-------------------------+
  1551. +|`PUT` | Actualiza un recurso |
  1552. ++-----------------+-------------------------+
  1553. +|`DELETE` | Borra un recurso |
  1554. ++-----------------+-------------------------+
  1555. +
  1556. +Ejemplo
  1557. +''''''''''''
  1558. +
  1559. +**Contenido Body**
  1560. +
  1561. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  1562. +
  1563. +.. code:: json
  1564. +
  1565. + {
  1566. + "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1567. + "estado": true,
  1568. + "fecha_creacion": "2016-07-26T14:37:08.938Z",
  1569. + "fecha_modificacion": "2016-07-26T14:37:08.938Z",
  1570. + "fk_persona": 1091, //Sylvain Damien Lesage
  1571. + "fk_cargo": 1266 //Director Ejecutivo
  1572. + }
  1573. +
  1574. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  1575. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  1576. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  1577. +| /contrataciones | Obtiene el listado de todos las contrataciones | Crea un registro de contratación | | |
  1578. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  1579. +| /contrataciones/:id | Obtiene contratación identificado como :id | | Actualiza registro :id de contratación | Elimina registro :id de contratación |
  1580. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  1581. +
  1582. +
  1583. +Tabla de parámetros opcionales de la URL para peticines GET
  1584. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  1585. +-+-----------+------------------+---------------------------------------------------------------------+
  1586. |**Nombre** |**Tipo** |**Descripción** |
  1587. +=+===========+==================+=====================================================================+
  1588. @@ -87,569 +68,25 @@ Tabla de parámetros
  1589. | |`entidad` | String |El nombre de la entidad. |
  1590. +-+-----------+------------------+---------------------------------------------------------------------+
  1591.  
  1592. -Muestra una determinada cantidad de contrataciones
  1593. -''''''''''''''''''''''''''''''''''''''''''''''''''
  1594. -
  1595. -**URL**
  1596. -::
  1597. -
  1598. - /contrataciones?elementos=valor
  1599. -
  1600. -**Parámetros usados**
  1601. -
  1602. -============ =====================
  1603. -**Nombre** **Valor enviado**
  1604. -============ =====================
  1605. -`elementos` 1
  1606. -============ =====================
  1607. -
  1608. -**Ejemplo:**
  1609. -
  1610. -::
  1611. -
  1612. - /contrataciones?elementos=1
  1613. -
  1614. -**Respuesta:**
  1615. -
  1616. -.. code:: json
  1617. -
  1618. - {
  1619. - "count": 3,
  1620. - "rows": [
  1621. - {
  1622. - "_id": 1,
  1623. - "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1624. - "estado": true,
  1625. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1626. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1627. - "fk_persona": 1,
  1628. - "fk_cargo": 1,
  1629. - "fk_tipo_contrato": 1
  1630. - }
  1631. - ]
  1632. - }
  1633. -
  1634. -Muestra las contrataciones en una determinada página
  1635. -''''''''''''''''''''''''''''''''''''''''''''''''''''
  1636. -
  1637. -**URL**
  1638. -::
  1639. -
  1640. - /contrataciones?pagina=valor
  1641. -
  1642. -**Parámetros usados**
  1643. -
  1644. -============ =====================
  1645. -**Nombre** **Valor enviado**
  1646. -============ =====================
  1647. -`pagina` 1
  1648. -============ =====================
  1649. -
  1650. -**Ejemplo:**
  1651. -::
  1652. -
  1653. - /contrataciones?pagina=1
  1654. -
  1655. -**Respuesta:**
  1656. -
  1657. -.. code:: json
  1658. -
  1659. - {
  1660. - "count": 3,
  1661. - "rows": [
  1662. - {
  1663. - "_id": 1,
  1664. - "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1665. - "estado": true,
  1666. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1667. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1668. - "fk_persona": 1,
  1669. - "fk_cargo": 1,
  1670. - "fk_tipo_contrato": 1
  1671. - },
  1672. - {
  1673. - "_id": 2,
  1674. - "fechaContratacion": "2000-08-12T20:58:20.042Z",
  1675. - "estado": true,
  1676. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1677. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1678. - "fk_persona": 2,
  1679. - "fk_cargo": 3,
  1680. - "fk_tipo_contrato": 3
  1681. - },
  1682. - {
  1683. - "_id": 3,
  1684. - "fechaContratacion": "2005-01-15T20:58:20.042Z",
  1685. - "estado": true,
  1686. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1687. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1688. - "fk_persona": 3,
  1689. - "fk_cargo": 4,
  1690. - "fk_tipo_contrato": 3
  1691. - }
  1692. - ]
  1693. - }
  1694. -
  1695. -Ordena las contrataciones ascendentemente en base a un campo del modelo
  1696. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  1697. -
  1698. -**URL**
  1699. -::
  1700. -
  1701. - /contrataciones?ordenarPor=valor
  1702. -
  1703. -**Parámetros usados**
  1704. -
  1705. -============ =====================
  1706. -**Nombre** **Valor enviado**
  1707. -============ =====================
  1708. -`ordenarPor` fechaContratacion
  1709. -============ =====================
  1710. -
  1711. -**Ejemplo**
  1712. -::
  1713. -
  1714. - /contrataciones?ordenarPor=fechaContratacion
  1715. -
  1716. -**Respuesta:**
  1717. -
  1718. -.. code:: json
  1719. -
  1720. - {
  1721. - "count": 3,
  1722. - "rows": [
  1723. - {
  1724. - "_id": 2,
  1725. - "fechaContratacion": "2000-08-12T20:58:20.042Z",
  1726. - "estado": true,
  1727. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1728. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1729. - "fk_persona": 2,
  1730. - "fk_cargo": 3,
  1731. - "fk_tipo_contrato": 3
  1732. - },
  1733. - {
  1734. - "_id": 3,
  1735. - "fechaContratacion": "2005-01-15T20:58:20.042Z",
  1736. - "estado": true,
  1737. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1738. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1739. - "fk_persona": 3,
  1740. - "fk_cargo": 4,
  1741. - "fk_tipo_contrato": 3
  1742. - },
  1743. - {
  1744. - "_id": 1,
  1745. - "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1746. - "estado": true,
  1747. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1748. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1749. - "fk_persona": 1,
  1750. - "fk_cargo": 1,
  1751. - "fk_tipo_contrato": 1
  1752. - }
  1753. - ]
  1754. - }
  1755. -
  1756. -Ordena las contrataciones descendentemente en base a un campo del modelo
  1757. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  1758. -
  1759. -**URL**
  1760. -::
  1761. -
  1762. - /contrataciones?ordenarPor=valor1&orden=true
  1763. -
  1764. -**Parámetros usados**
  1765. -
  1766. -============ =================
  1767. -**Nombre** **Valor enviado**
  1768. -============ =================
  1769. -`ordenarPor` fechaContratacion
  1770. -`orden` true
  1771. -============ =================
  1772. -
  1773. -**Ejemplo:**
  1774. -::
  1775. -
  1776. - /contrataciones?ordenarPor=fechaContratacion&orden=true
  1777. -
  1778. -**Respuesta:**
  1779. -
  1780. -.. code:: json
  1781. -
  1782. - {
  1783. - "count": 3,
  1784. - "rows": [
  1785. - {
  1786. - "_id": 1,
  1787. - "fechaContratacion": "2016-04-27T20:58:20.042Z",
  1788. - "estado": true,
  1789. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1790. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1791. - "fk_persona": 1,
  1792. - "fk_cargo": 1,
  1793. - "fk_tipo_contrato": 1
  1794. - },
  1795. - {
  1796. - "_id": 3,
  1797. - "fechaContratacion": "2005-01-15T20:58:20.042Z",
  1798. - "estado": true,
  1799. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1800. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1801. - "fk_persona": 3,
  1802. - "fk_cargo": 4,
  1803. - "fk_tipo_contrato": 3
  1804. - },
  1805. - {
  1806. - "_id": 2,
  1807. - "fechaContratacion": "2000-08-12T20:58:20.042Z",
  1808. - "estado": true,
  1809. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1810. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1811. - "fk_persona": 2,
  1812. - "fk_cargo": 3,
  1813. - "fk_tipo_contrato": 3
  1814. - }
  1815. - ]
  1816. - }
  1817. -
  1818. -Buscar por "palabra" en "campo" de la entidad contratación
  1819. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  1820. -
  1821. -**URL**
  1822. -::
  1823. -
  1824. - /contrataciones?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  1825. -
  1826. -**Parámetros usados**
  1827. -
  1828. -============ ===========================================
  1829. -**Nombre** **Valor enviado**
  1830. -============ ===========================================
  1831. -`buscar` ::
  1832. -
  1833. - [{"en":"fechaContratacion","palabra":"2000"}]
  1834. -============ ===========================================
  1835. -
  1836. -**Ejemplo**
  1837. -::
  1838. -
  1839. - /contrataciones?buscar=%7B%22en%22:%22fechaContratacion%22,%22palabra%22:%222000%22%7D
  1840. -
  1841. -**Respuesta:**
  1842. -
  1843. -.. code:: json
  1844. -
  1845. - {
  1846. - "count": 1,
  1847. - "rows": [
  1848. - {
  1849. - "_id": 2,
  1850. - "fechaContratacion": "2000-08-12T20:58:20.042Z",
  1851. - "estado": true,
  1852. - "fecha_creacion": "2016-05-30T14:37:14.689Z",
  1853. - "fecha_modificacion": "2016-05-30T14:37:14.689Z",
  1854. - "fk_persona": 2,
  1855. - "fk_cargo": 3,
  1856. - "fk_tipo_contrato": 3
  1857. - }
  1858. - ]
  1859. - }
  1860. -
  1861. -Respuesta de error
  1862. -``````````````````
  1863. -
  1864. -**Código:** 500
  1865. -
  1866. -**Contenido:**
  1867. -
  1868. -.. code:: json
  1869. -
  1870. - {
  1871. - "error":"Ocurrio un problema inesperado en el servidor"
  1872. - }
  1873. -
  1874. -
  1875. -Observaciones
  1876. -`````````````
  1877. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  1878. -- El parámetro 'orden' depende de 'ordenarPor'
  1879. -- El parámetro 'pagina' muestra 15 contrataciones por defecto
  1880. -
  1881. -----
  1882. -
  1883. -Crear una contratacion
  1884. -----------------------
  1885. -
  1886. -URL
  1887. -```
  1888. -::
  1889. -
  1890. - /contrataciones
  1891. -
  1892. -Método
  1893. -``````
  1894. -``POST``
  1895. -
  1896. -Parámetros del body
  1897. -```````````````````
  1898. -**Ejemplo**
  1899. -
  1900. -.. code:: json
  1901. -
  1902. - {
  1903. - "fechaContratacion": "2016-06-06T20:58:20.042Z",
  1904. - "estado": true,
  1905. - "fk_persona": 5,
  1906. - "fk_cargo": 2,
  1907. - "fk_tipo_contrato": 4
  1908. - }
  1909. -
  1910. -Respuesta correcta
  1911. -``````````````````
  1912. -
  1913. -**Código:** 201
  1914. -
  1915. -**Contenido:**
  1916. -
  1917. -.. code:: json
  1918. -
  1919. - {
  1920. - "_id": 24,
  1921. - "fechaContratacion": "2016-06-06T20:58:20.042Z",
  1922. - "estado": true,
  1923. - "fecha_creacion": "2016-05-30T15:02:39.034Z",
  1924. - "fecha_modificacion": "2016-05-30T15:02:39.034Z",
  1925. - "fk_persona": 5,
  1926. - "fk_cargo": 2,
  1927. - "fk_tipo_contrato": 4
  1928. - }
  1929. -
  1930. -Respuesta de error
  1931. -``````````````````
  1932. -
  1933. -**Código:** 400
  1934. -
  1935. -**Contenido:**
  1936. -
  1937. -.. code:: json
  1938. -
  1939. - {
  1940. - "name": "SequelizeValidationError",
  1941. - "message": "Validation error: El formato de la fecha es incorrecto",
  1942. - "errors": [
  1943. - {
  1944. - "message": "El formato de la fecha es incorrecto",
  1945. - "type": "Validation error",
  1946. - "path": "fechaContratacion",
  1947. - "value": {},
  1948. - "__raw": {}
  1949. - }
  1950. - ]
  1951. - }
  1952. -
  1953. -----
  1954. -
  1955. -Mostrar una contratacion
  1956. -------------------------
  1957. -URL
  1958. -```
  1959. -::
  1960. -
  1961. - /contrataciones/:id
  1962. -
  1963. -Método
  1964. -``````
  1965. -``GET``
  1966. -
  1967. -Parámetros de la URL
  1968. -````````````````````
  1969. -
  1970. -**Parámetro requerido:**
  1971. -
  1972. -============ ============== ================================================
  1973. -**Nombre** **Tipo** **Descripción**
  1974. -============ ============== ================================================
  1975. -`id` Integer Identificador único del registro en la entidad.
  1976. -============ ============== ================================================
  1977. -
  1978. -**Ejemplo**
  1979. -::
  1980. -
  1981. - id=24
  1982. -
  1983. -Respuesta correcta
  1984. -``````````````````
  1985. -
  1986. -**Código:** 200
  1987. -
  1988. -**Ejemplo**
  1989. -
  1990. -.. code:: json
  1991. -
  1992. - {
  1993. - "_id": 24,
  1994. - "fechaContratacion": "2016-06-06T20:58:20.042Z",
  1995. - "estado": true,
  1996. - "fecha_creacion": "2016-05-30T15:02:39.034Z",
  1997. - "fecha_modificacion": "2016-05-30T15:02:39.034Z",
  1998. - "fk_persona": 5,
  1999. - "fk_cargo": 2,
  2000. - "fk_tipo_contrato": 4
  2001. - }
  2002. -
  2003. -Respuesta de error
  2004. -``````````````````
  2005. -
  2006. -**Código:** 404
  2007. -
  2008. -**Contenido:**
  2009. -
  2010. -.. code:: json
  2011. -
  2012. - {
  2013. - "message": "Entidad no encontrada"
  2014. - }
  2015. -
  2016. -----
  2017. -
  2018. -Editar una contratacion
  2019. ------------------------
  2020. -URL
  2021. -```
  2022. -::
  2023. -
  2024. - /contrataciones/:id
  2025. -
  2026. -Método
  2027. -``````
  2028. -``PUT``
  2029. -
  2030. -Parámetros de la URL
  2031. -````````````````````
  2032. -
  2033. -**Parámetro requerido:**
  2034. -
  2035. -============ ============== ================================================
  2036. -**Nombre** **Tipo** **Descripción**
  2037. -============ ============== ================================================
  2038. -`id` Integer Identificador único del registro en la entidad.
  2039. -============ ============== ================================================
  2040. -
  2041. -**Ejemplo**
  2042. -::
  2043. -
  2044. - id=24
  2045. -
  2046. -Parámetros del body
  2047. -```````````````````
  2048. -
  2049. -**Ejemplo**
  2050. -
  2051. -.. code:: json
  2052. -
  2053. - {
  2054. - "fechaContratacion": "2016-06-01T20:58:20.042Z",
  2055. - }
  2056. -
  2057. -
  2058. -Respuesta correcta
  2059. -``````````````````
  2060. -
  2061. -**Código:** 200
  2062. -
  2063. -**Contenido:**
  2064. -
  2065. -.. code:: json
  2066. -
  2067. - {
  2068. - "_id": 24,
  2069. - "fechaContratacion": "2016-06-01T20:58:20.042Z",
  2070. - "estado": true,
  2071. - "fecha_creacion": "2016-05-30T15:02:39.034Z",
  2072. - "fecha_modificacion": "2016-05-30T15:02:39.034Z",
  2073. - "fk_persona": 5,
  2074. - "fk_cargo": 2,
  2075. - "fk_tipo_contrato": 4
  2076. - }
  2077. -
  2078. -Respuesta de error
  2079. -``````````````````
  2080. -
  2081. -**Código:** 404
  2082. -
  2083. -**Contenido:**
  2084. -
  2085. -.. code:: json
  2086. -
  2087. - {
  2088. - "message": "Entidad no encontrada"
  2089. - }
  2090. -
  2091. -**Código:** 400
  2092. -
  2093. -**Contenido:**
  2094. -
  2095. -.. code:: json
  2096. -
  2097. - {
  2098. - "name": "SequelizeValidationError",
  2099. - "message": "Validation error: El formato de la fecha es incorrecto",
  2100. - "errors": [
  2101. - {
  2102. - "message": "El formato de la fecha es incorrecto",
  2103. - "type": "Validation error",
  2104. - "path": "fechaContratacion",
  2105. - "value": {},
  2106. - "__raw": {}
  2107. - }
  2108. - ]
  2109. - }
  2110. -
  2111. -----
  2112. -
  2113. -Eliminar una contratacion
  2114. --------------------------
  2115. -URL
  2116. -```
  2117. -::
  2118. -
  2119. - /contrataciones/:id
  2120. -
  2121. -Método
  2122. -``````
  2123. -``DELETE``
  2124. -
  2125. -Parámetros de la URL
  2126. -````````````````````
  2127. -
  2128. -**Parámetro requerido:**
  2129. -
  2130. -============ ============== ================================================
  2131. -**Nombre** **Tipo** **Descripción**
  2132. -============ ============== ================================================
  2133. -`id` Integer Identificador único del registro en la entidad.
  2134. -============ ============== ================================================
  2135. -
  2136. -**Ejemplo**
  2137. -::
  2138. -
  2139. - id=24
  2140. -
  2141. -Respuesta correcta
  2142. -``````````````````
  2143. -
  2144. -**Código:** 204
  2145. -
  2146. -Respuesta de error
  2147. -``````````````````
  2148. -
  2149. -**Código:** 404
  2150. -
  2151. -**Contenido:**
  2152. -
  2153. -.. code:: json
  2154. -
  2155. - {
  2156. - "message": "Entidad no encontrada"
  2157. - }
  2158. +Respuestas
  2159. +----------
  2160. +
  2161. ++------------------+----------------------------------------------------------------------------------------------+
  2162. +| **Código HTTP** | **Descripción** |
  2163. ++==================+==============================================================================================+
  2164. +| `200` | Ok |
  2165. ++------------------+----------------------------------------------------------------------------------------------+
  2166. +| `201` | Creado |
  2167. ++------------------+----------------------------------------------------------------------------------------------+
  2168. +| `400` | Parámetros incorrectos en la entrada |
  2169. ++------------------+----------------------------------------------------------------------------------------------+
  2170. +| `401` | Token de acceso expirado o invalido |
  2171. ++------------------+----------------------------------------------------------------------------------------------+
  2172. +| `404` | Recurso no encontrado |
  2173. ++------------------+----------------------------------------------------------------------------------------------+
  2174. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  2175. ++------------------+----------------------------------------------------------------------------------------------+
  2176. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  2177. ++------------------+----------------------------------------------------------------------------------------------+
  2178. +| `500` | Error interno del servidor |
  2179. ++------------------+----------------------------------------------------------------------------------------------+
  2180. diff --git a/docs/datoOficina/datoOficina.rst b/docs/datoOficina/datoOficina.rst
  2181. index f0e7c5b..0ae4b89 100644
  2182. --- a/docs/datoOficina/datoOficina.rst
  2183. +++ b/docs/datoOficina/datoOficina.rst
  2184. @@ -1,648 +1,65 @@
  2185. -Datos de Oficina
  2186. -================
  2187. +Datos Oficina
  2188. +====================
  2189.  
  2190. -Mostrar todas los datos de oficina
  2191. -----------------------------------
  2192. -
  2193. -URL
  2194. -```
  2195. -::
  2196. -
  2197. - /datosOficina
  2198. -
  2199. -Método
  2200. -``````
  2201. -``GET``
  2202. -
  2203. -Respuesta correcta
  2204. -``````````````````
  2205. -
  2206. -**Código:** 200
  2207. -
  2208. -**Contenido:**
  2209. -
  2210. -.. code:: json
  2211. -
  2212. - {
  2213. - "count": 3,
  2214. - "rows": [
  2215. - {
  2216. - "_id": 1,
  2217. - "valor": "2200002",
  2218. - "principal": true,
  2219. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2220. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2221. - "fk_oficina": 1,
  2222. - "propiedad": "TEL-CENTRAL"
  2223. - },
  2224. - {
  2225. - "_id": 3,
  2226. - "valor": "2200003",
  2227. - "principal": true,
  2228. - "fecha_creacion": "2016-04-27T20:33:46.396Z",
  2229. - "fecha_modificacion": "2016-04-27T20:33:46.396Z",
  2230. - "fk_oficina": 1,
  2231. - "propiedad": "TEL-CENTRAL"
  2232. - },
  2233. - {
  2234. - "_id": 4,
  2235. - "valor": "2200004",
  2236. - "principal": true,
  2237. - "fecha_creacion": "2016-04-27T20:33:53.112Z",
  2238. - "fecha_modificacion": "2016-04-27T20:33:53.112Z",
  2239. - "fk_oficina": 1,
  2240. - "propiedad": "TEL-CENTRAL"
  2241. - }
  2242. - ]
  2243. - }
  2244. -
  2245. -Parámetros opcionales de la URL
  2246. -```````````````````````````````
  2247. -Tabla de parámetros
  2248. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2249. -+-+-----------+------------------+---------------------------------------------------------------------+
  2250. -|**Nombre** |**Tipo** |**Descripción** |
  2251. -+=+===========+==================+=====================================================================+
  2252. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  2253. -+-+-----------+------------------+---------------------------------------------------------------------+
  2254. -|`pagina` | Integer |El número de página a mostrar. |
  2255. -+-+-----------+------------------+---------------------------------------------------------------------+
  2256. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  2257. -+-+-----------+------------------+---------------------------------------------------------------------+
  2258. -|`orden` | Boolean |TRUE para un orden descendente. |
  2259. -+-+-----------+------------------+---------------------------------------------------------------------+
  2260. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  2261. -+-+-----------+------------------+---------------------------------------------------------------------+
  2262. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  2263. -+-+-----------+------------------+---------------------------------------------------------------------+
  2264. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  2265. -+-+-----------+------------------+---------------------------------------------------------------------+
  2266. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  2267. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  2268. -| | |`buscar` definido anteriormente) |
  2269. -+-+-----------+------------------+---------------------------------------------------------------------+
  2270. -| |`entidad` | String |El nombre de la entidad. |
  2271. -+-+-----------+------------------+---------------------------------------------------------------------+
  2272. -
  2273. -Muestra una determinada cantidad de entidades
  2274. -'''''''''''''''''''''''''''''''''''''''''''''
  2275. -
  2276. -**URL**
  2277. -::
  2278. -
  2279. - /datosOficina?elementos=valor
  2280. -
  2281. -**Parámetros usados**
  2282. -
  2283. -============ =====================
  2284. -**Nombre** **Valor enviado**
  2285. -============ =====================
  2286. -`elementos` 1
  2287. -============ =====================
  2288. -
  2289. -**Ejemplo:**
  2290. -
  2291. -::
  2292. -
  2293. - /datosOficina?elementos=1
  2294. -
  2295. -**Respuesta:**
  2296. -
  2297. -.. code:: json
  2298. -
  2299. - {
  2300. - "count": 3,
  2301. - "rows": [
  2302. - {
  2303. - "_id": 1,
  2304. - "valor": "2200002",
  2305. - "principal": true,
  2306. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2307. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2308. - "fk_oficina": 1,
  2309. - "propiedad": "TEL-CENTRAL"
  2310. - }
  2311. - ]
  2312. - }
  2313. -
  2314. -Muestra los datos de oficina en una determinada página
  2315. -'''''''''''''''''''''''''''''''''''''''''''''''''''''
  2316. -
  2317. -**URL**
  2318. -::
  2319. -
  2320. - /datosOficina?pagina=valor
  2321. -
  2322. -**Parámetros usados**
  2323. -
  2324. -============ =====================
  2325. -**Nombre** **Valor enviado**
  2326. -============ =====================
  2327. -`pagina` 1
  2328. -============ =====================
  2329. -
  2330. -**Ejemplo:**
  2331. -::
  2332. -
  2333. - /datosOficina?pagina=1
  2334. -
  2335. -**Respuesta:**
  2336. -
  2337. -.. code:: json
  2338. -
  2339. - {
  2340. - "count": 3,
  2341. - "rows": [
  2342. - {
  2343. - "_id": 1,
  2344. - "valor": "2200002",
  2345. - "principal": true,
  2346. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2347. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2348. - "fk_oficina": 1,
  2349. - "propiedad": "TEL-CENTRAL"
  2350. - },
  2351. - {
  2352. - "_id": 3,
  2353. - "valor": "2200003",
  2354. - "principal": true,
  2355. - "fecha_creacion": "2016-04-27T20:33:46.396Z",
  2356. - "fecha_modificacion": "2016-04-27T20:33:46.396Z",
  2357. - "fk_oficina": 1,
  2358. - "propiedad": "TEL-CENTRAL"
  2359. - },
  2360. - {
  2361. - "_id": 4,
  2362. - "valor": "2200004",
  2363. - "principal": true,
  2364. - "fecha_creacion": "2016-04-27T20:33:53.112Z",
  2365. - "fecha_modificacion": "2016-04-27T20:33:53.112Z",
  2366. - "fk_oficina": 1,
  2367. - "propiedad": "TEL-CENTRAL"
  2368. - }
  2369. - ]
  2370. - }
  2371. -
  2372. -Ordena los datos de oficina ascendentemente en base a un campo del modelo
  2373. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2374. -
  2375. -**URL**
  2376. -::
  2377. -
  2378. - /datosOficina?ordenarPor=valor
  2379. -
  2380. -**Parámetros usados**
  2381. -
  2382. -============ =====================
  2383. -**Nombre** **Valor enviado**
  2384. -============ =====================
  2385. -`ordenarPor` valor
  2386. -============ =====================
  2387. -
  2388. -**Ejemplo**
  2389. -::
  2390. -
  2391. - /datosOficina?ordenarPor=valor
  2392. -
  2393. -**Respuesta:**
  2394. -
  2395. -.. code:: json
  2396. -
  2397. - {
  2398. - "count": 3,
  2399. - "rows": [
  2400. - {
  2401. - "_id": 1,
  2402. - "valor": "2200002",
  2403. - "principal": true,
  2404. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2405. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2406. - "fk_oficina": 1,
  2407. - "propiedad": "TEL-CENTRAL"
  2408. - },
  2409. - {
  2410. - "_id": 3,
  2411. - "valor": "2200003",
  2412. - "principal": true,
  2413. - "fecha_creacion": "2016-04-27T20:33:46.396Z",
  2414. - "fecha_modificacion": "2016-04-27T20:33:46.396Z",
  2415. - "fk_oficina": 1,
  2416. - "propiedad": "TEL-CENTRAL"
  2417. - },
  2418. - {
  2419. - "_id": 4,
  2420. - "valor": "2200004",
  2421. - "principal": true,
  2422. - "fecha_creacion": "2016-04-27T20:33:53.112Z",
  2423. - "fecha_modificacion": "2016-04-27T20:33:53.112Z",
  2424. - "fk_oficina": 1,
  2425. - "propiedad": "TEL-CENTRAL"
  2426. - }
  2427. - ]
  2428. - }
  2429. -
  2430. -Ordena los datos de oficina descendentemente en base a un campo del modelo
  2431. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2432. -
  2433. -**URL**
  2434. -::
  2435. -
  2436. - /datosOficina?ordenarPor=valor1&orden=true
  2437. -
  2438. -**Parámetros usados**
  2439. -
  2440. -============ =================
  2441. -**Nombre** **Valor enviado**
  2442. -============ =================
  2443. -`ordenarPor` nombre
  2444. -`orden` true
  2445. -============ =================
  2446. -
  2447. -**Ejemplo:**
  2448. -::
  2449. -
  2450. - /datosOficina?ordenarPor=valor&orden=true
  2451. -
  2452. -**Respuesta:**
  2453. -
  2454. -.. code:: json
  2455. -
  2456. - {
  2457. - "count": 3,
  2458. - "rows": [
  2459. - {
  2460. - "_id": 4,
  2461. - "valor": "2200004",
  2462. - "principal": true,
  2463. - "fecha_creacion": "2016-04-27T20:33:53.112Z",
  2464. - "fecha_modificacion": "2016-04-27T20:33:53.112Z",
  2465. - "fk_oficina": 1,
  2466. - "propiedad": "TEL-CENTRAL"
  2467. - },
  2468. - {
  2469. - "_id": 3,
  2470. - "valor": "2200003",
  2471. - "principal": true,
  2472. - "fecha_creacion": "2016-04-27T20:33:46.396Z",
  2473. - "fecha_modificacion": "2016-04-27T20:33:46.396Z",
  2474. - "fk_oficina": 1,
  2475. - "propiedad": "TEL-CENTRAL"
  2476. - },
  2477. - {
  2478. - "_id": 1,
  2479. - "valor": "2200002",
  2480. - "principal": true,
  2481. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2482. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2483. - "fk_oficina": 1,
  2484. - "propiedad": "TEL-CENTRAL"
  2485. - }
  2486. - ]
  2487. - }
  2488. -
  2489. -Buscar por "palabra" en "campo" en el modelo "entidad"
  2490. -''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2491. -
  2492. -**URL**
  2493. -::
  2494. -
  2495. - /datosOficina?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  2496. -
  2497. -**Parámetros usados**
  2498. -
  2499. -============ ===========================================
  2500. -**Nombre** **Valor enviado**
  2501. -============ ===========================================
  2502. -`buscar` ::
  2503. -
  2504. - [{"en":"valor","palabra":"2200003"}]
  2505. -============ ===========================================
  2506. -
  2507. -**Ejemplo**
  2508. -::
  2509. -
  2510. - /datosOficina?buscar=%7B%22en%22:%22valor%22,%22palabra%22:%222200003%22%7D
  2511. -
  2512. -**Respuesta:**
  2513. -
  2514. -.. code:: json
  2515. -
  2516. - {
  2517. - "count": 1,
  2518. - "rows": [
  2519. - {
  2520. - "_id": 3,
  2521. - "valor": "2200003",
  2522. - "principal": true,
  2523. - "fecha_creacion": "2016-04-27T20:33:46.396Z",
  2524. - "fecha_modificacion": "2016-04-27T20:33:46.396Z",
  2525. - "fk_oficina": 1,
  2526. - "propiedad": "TEL-CENTRAL"
  2527. - }
  2528. - ]
  2529. - }
  2530. -
  2531. -Respuesta de error
  2532. -``````````````````
  2533. -
  2534. -**Código:** 500
  2535. -
  2536. -**Contenido:**
  2537. -
  2538. -.. code:: json
  2539. -
  2540. - {
  2541. - "error":"Ocurrio un problema inesperado en el servidor"
  2542. - }
  2543. -
  2544. -
  2545. -Observaciones
  2546. -`````````````
  2547. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  2548. -- El parámetro 'orden' depende de 'ordenarPor'
  2549. -- El parámetro 'pagina' muestra 15 entidades por defecto
  2550. -
  2551. -----
  2552. -
  2553. -Crear un dato de oficina
  2554. +Formato URL
  2555. ------------------------
  2556. -
  2557. -URL
  2558. -```
  2559. -::
  2560. -
  2561. - /datosOficina
  2562. -
  2563. -Método
  2564. -``````
  2565. -``POST``
  2566. -
  2567. -Parámetros del body
  2568. -```````````````````
  2569. -**Ejemplo**
  2570. -
  2571. -.. code:: json
  2572. -
  2573. - {
  2574. - "valor": "2245640",
  2575. - "principal": true,
  2576. - "propiedad": "TEL-CENTRAL",
  2577. - "fk_oficina": 1
  2578. - }
  2579. -
  2580. -Respuesta correcta
  2581. -``````````````````
  2582. -
  2583. -**Código:** 201
  2584. -
  2585. -**Contenido:**
  2586. -
  2587. -.. code:: json
  2588. -
  2589. - {
  2590. - "_id": 10,
  2591. - "valor": "2245640",
  2592. - "principal": true,
  2593. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2594. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2595. - "fk_oficina": 1,
  2596. - "propiedad": "TEL-CENTRAL"
  2597. - }
  2598. -
  2599. -Respuesta de error
  2600. -``````````````````
  2601. -
  2602. -**Código:** 400
  2603. -
  2604. -**Contenido:**
  2605. -
  2606. -.. code:: json
  2607. -
  2608. - {
  2609. - "name": "SequelizeValidationError",
  2610. - "message": "Validation error: Ingrese el valor para el dato de oficina.",
  2611. - "errors": [
  2612. - {
  2613. - "message": "Ingrese el valor para el dato de oficina.",
  2614. - "type": "Validation error",
  2615. - "path": "valor",
  2616. - "value": {},
  2617. - "__raw": {}
  2618. - }
  2619. - ]
  2620. - }
  2621. -
  2622. -**Código:** 409
  2623. -
  2624. -**Contenido:**
  2625. -
  2626. -.. code:: json
  2627. -
  2628. - {
  2629. - "name": "SequelizeUniqueConstraintError",
  2630. - "message": "llave duplicada viola restricción de unicidad «unidad_organizacional_nombre_key»",
  2631. - "errors": {}
  2632. - }
  2633. -
  2634. -----
  2635. -
  2636. -Mostrar un dato de oficina
  2637. ---------------------------
  2638. -URL
  2639. -```
  2640. -::
  2641. -
  2642. - /datosOficina/:id
  2643. -
  2644. -Método
  2645. -``````
  2646. -``GET``
  2647. -
  2648. -Parámetros de la URL
  2649. -````````````````````
  2650. -
  2651. -**Parámetro requerido:**
  2652. -
  2653. -============ ============== ================================================
  2654. -**Nombre** **Tipo** **Descripción**
  2655. -============ ============== ================================================
  2656. -`id` Integer Identificador único del registro en la entidad.
  2657. -============ ============== ================================================
  2658. -
  2659. -**Ejemplo**
  2660. -::
  2661. -
  2662. - id=10
  2663. -
  2664. -Respuesta correcta
  2665. -``````````````````
  2666. -
  2667. -**Código:** 200
  2668. -
  2669. -**Ejemplo**
  2670. -
  2671. -.. code:: json
  2672. -
  2673. - {
  2674. - "_id": 10,
  2675. - "valor": "2245640",
  2676. - "principal": true,
  2677. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2678. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2679. - "fk_oficina": 1,
  2680. - "propiedad": "TEL-CENTRAL"
  2681. - }
  2682. -
  2683. -Respuesta de error
  2684. -``````````````````
  2685. -
  2686. -**Código:** 404
  2687. -
  2688. -**Contenido:**
  2689. -
  2690. -.. code:: json
  2691. -
  2692. - {
  2693. - "message": "Entidad no encontrada"
  2694. - }
  2695. -
  2696. -----
  2697. -
  2698. -Editar un dato de oficina
  2699. --------------------------
  2700. -URL
  2701. -```
  2702. -::
  2703. -
  2704. - /datosOficina/:id
  2705. -
  2706. -Método
  2707. -``````
  2708. -``PUT``
  2709. -
  2710. -Parámetros de la URL
  2711. -````````````````````
  2712. -
  2713. -**Parámetro requerido:**
  2714. -
  2715. -============ ============== ================================================
  2716. -**Nombre** **Tipo** **Descripción**
  2717. -============ ============== ================================================
  2718. -`id` Integer Identificador único del registro en la entidad.
  2719. -============ ============== ================================================
  2720. -
  2721. -**Ejemplo**
  2722. -::
  2723. -
  2724. - id=26
  2725. -
  2726. -Parámetros del body
  2727. -```````````````````
  2728. -
  2729. -**Ejemplo**
  2730. -
  2731. -.. code:: json
  2732. -
  2733. - {
  2734. - "valor": "2345678"
  2735. - }
  2736. -
  2737. -Respuesta correcta
  2738. -``````````````````
  2739. -
  2740. -**Código:** 200
  2741. -
  2742. -**Contenido:**
  2743. -
  2744. -.. code:: json
  2745. -
  2746. - {
  2747. - "_id": 10,
  2748. - "valor": "2345678",
  2749. - "principal": true,
  2750. - "fecha_creacion": "2016-04-27T20:28:49.910Z",
  2751. - "fecha_modificacion": "2016-04-27T20:31:37.041Z",
  2752. - "fk_oficina": 1,
  2753. - "propiedad": "TEL-CENTRAL"
  2754. - }
  2755. -
  2756. -Respuesta de error
  2757. -``````````````````
  2758. -
  2759. -**Código:** 404
  2760. -
  2761. -**Contenido:**
  2762. -
  2763. -.. code:: json
  2764. -
  2765. - {
  2766. - "message": "Entidad no encontrada"
  2767. - }
  2768. -
  2769. -**Código:** 400
  2770. -
  2771. -**Contenido:**
  2772. -
  2773. -.. code:: json
  2774. -
  2775. - {
  2776. - "name": "SequelizeValidationError",
  2777. - "message": "Validation error: Ingrese el valor para el dato de oficina.",
  2778. - "errors": [
  2779. - {
  2780. - "message": "Ingrese el valor para el dato de oficina.",
  2781. - "type": "Validation error",
  2782. - "path": "valor",
  2783. - "value": {},
  2784. - "__raw": {}
  2785. - }
  2786. - ]
  2787. - }
  2788. -
  2789. -----
  2790. -
  2791. -Eliminar un dato de oficina
  2792. ---------------------
  2793. -URL
  2794. -```
  2795. -::
  2796. -
  2797. - /datosOficina/:id
  2798. -
  2799. -Método
  2800. -``````
  2801. -``DELETE``
  2802. -
  2803. -Parámetros de la URL
  2804. -````````````````````
  2805. -
  2806. -**Parámetro requerido:**
  2807. -
  2808. -============ ============== ================================================
  2809. -**Nombre** **Tipo** **Descripción**
  2810. -============ ============== ================================================
  2811. -`id` Integer Identificador único del registro en la entidad.
  2812. -============ ============== ================================================
  2813. -
  2814. -**Ejemplo**
  2815. -::
  2816. -
  2817. - id=10
  2818. -
  2819. -Respuesta correcta
  2820. -``````````````````
  2821. -
  2822. -**Código:** 204
  2823. -
  2824. -Respuesta de error
  2825. -``````````````````
  2826. -
  2827. -**Código:** 404
  2828. -
  2829. -**Contenido:**
  2830. -
  2831. -.. code:: json
  2832. -
  2833. - {
  2834. - "message": "Entidad no encontrada"
  2835. - }
  2836. ++-----------------+-------------------------+
  2837. +|**Método HTTP** |**Significado** |
  2838. ++=================+=========================+
  2839. +|`GET` | Obtiene un recurso |
  2840. ++-----------------+-------------------------+
  2841. +|`POST` | Crea un recurso |
  2842. ++-----------------+-------------------------+
  2843. +|`PUT` | Actualiza un recurso |
  2844. ++-----------------+-------------------------+
  2845. +|`DELETE` | Borra un recurso |
  2846. ++-----------------+-------------------------+
  2847. +
  2848. +Ejemplo
  2849. +''''''''''''
  2850. +
  2851. +**Contenido Body**
  2852. +
  2853. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  2854. +
  2855. +.. code:: json
  2856. +
  2857. + {
  2858. + "valor": "'(591) 22445566",
  2859. + "principal": true,
  2860. + "fecha_creacion": "2016-07-26 10:37:08.885-04",
  2861. + "fecha_modificacion": "2016-07-26 10:37:08.885-04",
  2862. + "fk_oficina": 2, //Oficina Central
  2863. + "propiedad": "TEL-OFI" //Teléfono de Oficina
  2864. + }
  2865. +
  2866. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  2867. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  2868. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  2869. +| /datosOficina | Obtiene el listado de todos los Datos Oficina | Crea un registro de Datos Oficina | | |
  2870. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  2871. +| /datosOficina/:id | Obtiene el Datos Oficina identificado como :id | | Actualiza registro :id de Datos Oficina | Elimina registro :id de Datos Oficina |
  2872. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  2873. +
  2874. +Respuestas
  2875. +----------
  2876. +
  2877. ++------------------+----------------------------------------------------------------------------------------------+
  2878. +| **Código HTTP** | **Descripción** |
  2879. ++==================+==============================================================================================+
  2880. +| `200` | Ok |
  2881. ++------------------+----------------------------------------------------------------------------------------------+
  2882. +| `201` | Creado |
  2883. ++------------------+----------------------------------------------------------------------------------------------+
  2884. +| `400` | Parámetros incorrectos en la entrada |
  2885. ++------------------+----------------------------------------------------------------------------------------------+
  2886. +| `401` | Token de acceso expirado o invalido |
  2887. ++------------------+----------------------------------------------------------------------------------------------+
  2888. +| `404` | Recurso no encontrado |
  2889. ++------------------+----------------------------------------------------------------------------------------------+
  2890. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  2891. ++------------------+----------------------------------------------------------------------------------------------+
  2892. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  2893. ++------------------+----------------------------------------------------------------------------------------------+
  2894. +| `500` | Error interno del servidor |
  2895. ++------------------+----------------------------------------------------------------------------------------------+
  2896. diff --git a/docs/datoPersona/datoPersona.rst b/docs/datoPersona/datoPersona.rst
  2897. index 1c4b446..15032aa 100644
  2898. --- a/docs/datoPersona/datoPersona.rst
  2899. +++ b/docs/datoPersona/datoPersona.rst
  2900. @@ -1,801 +1,65 @@
  2901. -Datos de Persona
  2902. -===================
  2903. +Datos Persona
  2904. +====================
  2905.  
  2906. -Mostrar todos los datos de persona
  2907. ---------------------------------------
  2908. -
  2909. -URL
  2910. -```
  2911. -::
  2912. -
  2913. - /datosPersonas
  2914. -
  2915. -Método
  2916. -``````
  2917. -``GET``
  2918. -
  2919. -Respuesta correcta
  2920. -``````````````````
  2921. -
  2922. -**Código:** 200
  2923. -
  2924. -**Contenido:**
  2925. -
  2926. -.. code:: json
  2927. -
  2928. - {
  2929. - "count":4,
  2930. - "rows": [
  2931. - {
  2932. - "_id": 2,
  2933. - "valor": "daniel@daniel.com",
  2934. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  2935. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  2936. - "fk_persona": 1,
  2937. - "propiedad": "EMAIL"
  2938. - },
  2939. - {
  2940. - "_id": 3,
  2941. - "valor": "abc@gmail.com",
  2942. - "fecha_creacion": "2016-03-16T22:08:55.216Z",
  2943. - "fecha_modificacion": "2016-03-16T22:08:55.216Z",
  2944. - "fk_persona": 10,
  2945. - "propiedad": "EMAIL"
  2946. - },
  2947. - {
  2948. - "_id": 4,
  2949. - "valor": "palvarez@adsib.gob.bo",
  2950. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  2951. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  2952. - "fk_persona": 5,
  2953. - "propiedad": "EMAIL"
  2954. - },
  2955. - {
  2956. - "_id": 5,
  2957. - "valor": "kevin@hotmail.com",
  2958. - "fecha_creacion": "2016-07-22T22:09:15.115Z",
  2959. - "fecha_modificacion": "2016-07-22T22:09:15.115Z",
  2960. - "fk_persona": 2,
  2961. - "propiedad": "EMAIL"
  2962. - }
  2963. - ]
  2964. - }
  2965. -
  2966. -Parámetros opcionales de la URL
  2967. -```````````````````````````````
  2968. -Tabla de parámetros
  2969. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2970. -+-+-----------+------------------+---------------------------------------------------------------------+
  2971. -|**Nombre** |**Tipo** |**Descripción** |
  2972. -+=+===========+==================+=====================================================================+
  2973. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  2974. -+-+-----------+------------------+---------------------------------------------------------------------+
  2975. -|`pagina` | Integer |El número de página a mostrar. |
  2976. -+-+-----------+------------------+---------------------------------------------------------------------+
  2977. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  2978. -+-+-----------+------------------+---------------------------------------------------------------------+
  2979. -|`orden` | Boolean |TRUE para un orden descendente. |
  2980. -+-+-----------+------------------+---------------------------------------------------------------------+
  2981. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  2982. -+-+-----------+------------------+---------------------------------------------------------------------+
  2983. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  2984. -+-+-----------+------------------+---------------------------------------------------------------------+
  2985. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  2986. -+-+-----------+------------------+---------------------------------------------------------------------+
  2987. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  2988. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  2989. -| | |`buscar` definido anteriormente) |
  2990. -+-+-----------+------------------+---------------------------------------------------------------------+
  2991. -| |`entidad` | String |El nombre de la entidad. |
  2992. -+-+-----------+------------------+---------------------------------------------------------------------+
  2993. -
  2994. -Muestra una determinada cantidad de datos de personas
  2995. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  2996. -
  2997. -**URL**
  2998. -::
  2999. -
  3000. - /datosPersonas?elementos=valor
  3001. -
  3002. -**Parámetros usados**
  3003. -
  3004. -============ =====================
  3005. -**Nombre** **Valor enviado**
  3006. -============ =====================
  3007. -`elementos` 1
  3008. -============ =====================
  3009. -
  3010. -**Ejemplo:**
  3011. -::
  3012. -
  3013. - /datosPersonas?elementos=3
  3014. -
  3015. -**Respuesta:**
  3016. -
  3017. -.. code:: json
  3018. -
  3019. - {
  3020. - "count":4,"rows":
  3021. - [
  3022. - {
  3023. - "_id": 2,
  3024. - "valor": "daniel@daniel.com",
  3025. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  3026. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  3027. - "fk_persona": 1,
  3028. - "propiedad": "EMAIL"
  3029. - },
  3030. - {
  3031. - "_id": 3,
  3032. - "valor": "abc@gmail.com",
  3033. - "fecha_creacion": "2016-03-16T22:08:55.216Z",
  3034. - "fecha_modificacion": "2016-03-16T22:08:55.216Z",
  3035. - "fk_persona": 10,
  3036. - "propiedad": "EMAIL"
  3037. - },
  3038. - {
  3039. - "_id": 4,
  3040. - "valor": "palvarez@adsib.gob.bo",
  3041. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3042. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3043. - "fk_persona": 5,
  3044. - "propiedad": "EMAIL"
  3045. - }
  3046. - ]
  3047. - }
  3048. -
  3049. -Muestra los datos de cada Postulante en una determinada página
  3050. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  3051. -
  3052. -**URL**
  3053. -::
  3054. -
  3055. - /datosPersonas?pagina=valor
  3056. -
  3057. -**Parámetros usados**
  3058. -
  3059. -============ =====================
  3060. -**Nombre** **Valor enviado**
  3061. -============ =====================
  3062. -`pagina` 1
  3063. -============ =====================
  3064. -
  3065. -**Ejemplo:**
  3066. -::
  3067. -
  3068. - /datosPersonas?pagina=1
  3069. -
  3070. -**Respuesta:**
  3071. -
  3072. -.. code:: json
  3073. -
  3074. - {
  3075. - "count":4,"rows":
  3076. - [
  3077. - {
  3078. - "_id": 2,
  3079. - "valor": "daniel@daniel.com",
  3080. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  3081. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  3082. - "fk_persona": 1,
  3083. - "propiedad": "EMAIL"
  3084. - },
  3085. - {
  3086. - "_id": 3,
  3087. - "valor": "abc@gmail.com",
  3088. - "fecha_creacion": "2016-03-16T22:08:55.216Z",
  3089. - "fecha_modificacion": "2016-03-16T22:08:55.216Z",
  3090. - "fk_persona": 10,
  3091. - "propiedad": "EMAIL"
  3092. - },
  3093. - {
  3094. - "_id": 4,
  3095. - "valor": "palvarez@adsib.gob.bo",
  3096. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3097. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3098. - "fk_persona": 5,
  3099. - "propiedad": "EMAIL"
  3100. - },
  3101. - {
  3102. - "_id": 5,
  3103. - "valor": "kevin@hotmail.com",
  3104. - "fecha_creacion": "2016-07-22T22:09:15.115Z",
  3105. - "fecha_modificacion": "2016-07-22T22:09:15.115Z",
  3106. - "fk_persona": 2,
  3107. - "propiedad": "EMAIL"
  3108. - }
  3109. - ]
  3110. - }
  3111. -
  3112. -Ordena los datos de personas ascendentemente en base a un campo del modelo
  3113. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  3114. -
  3115. -**URL**
  3116. -::
  3117. -
  3118. - /datosPersonas?ordenarPor=valor
  3119. -
  3120. -**Parámetros usados**
  3121. -
  3122. -============ =====================
  3123. -**Nombre** **Valor enviado**
  3124. -============ =====================
  3125. -`ordenarPor` valor
  3126. -============ =====================
  3127. -
  3128. -**Ejemplo:**
  3129. -::
  3130. -
  3131. - /datosPersonas?ordenarPor=valor
  3132. -
  3133. -**Respuesta:**
  3134. -
  3135. -.. code:: json
  3136. -
  3137. - {
  3138. - "count":4,"rows":
  3139. - [
  3140. - {
  3141. - "_id": 3,
  3142. - "valor": "abc@gmail.com",
  3143. - "fecha_creacion": "2016-03-16T22:08:55.216Z",
  3144. - "fecha_modificacion": "2016-03-16T22:08:55.216Z",
  3145. - "fk_persona": 10,
  3146. - "propiedad": "EMAIL"
  3147. - },
  3148. - {
  3149. - "_id": 2,
  3150. - "valor": "daniel@daniel.com",
  3151. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  3152. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  3153. - "fk_persona": 1,
  3154. - "propiedad": "EMAIL"
  3155. - },
  3156. - {
  3157. - "_id": 5,
  3158. - "valor": "kevin@hotmail.com",
  3159. - "fecha_creacion": "2016-07-22T22:09:15.115Z",
  3160. - "fecha_modificacion": "2016-07-22T22:09:15.115Z",
  3161. - "fk_persona": 2,
  3162. - "propiedad": "EMAIL"
  3163. - },
  3164. - {
  3165. - "_id": 4,
  3166. - "valor": "palvarez@adsib.gob.bo",
  3167. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3168. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3169. - "fk_persona": 5,
  3170. - "propiedad": "EMAIL"
  3171. - }
  3172. - ]
  3173. - }
  3174. -
  3175. -Ordena los datos de personas descendentemente en base a un campo del modelo
  3176. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  3177. -
  3178. -**URL**
  3179. -::
  3180. -
  3181. - /datosPersonas?ordenarPor=valor1&orden=true
  3182. -
  3183. -**Parámetros usados**
  3184. -
  3185. -============ =================
  3186. -**Nombre** **Valor enviado**
  3187. -============ =================
  3188. -`ordenarPor` valor
  3189. -`orden` true
  3190. -============ =================
  3191. -
  3192. -**Ejemplo:**
  3193. -::
  3194. -
  3195. - /datosPersonas?ordenarPor=valor&orden=true
  3196. -
  3197. -**Respuesta:**
  3198. -
  3199. -.. code:: json
  3200. -
  3201. - {
  3202. - "count":4,"rows":
  3203. - [
  3204. - {
  3205. - "_id": 4,
  3206. - "valor": "palvarez@adsib.gob.bo",
  3207. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3208. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3209. - "fk_persona": 5,
  3210. - "propiedad": "EMAIL"
  3211. - },
  3212. - {
  3213. - "_id": 5,
  3214. - "valor": "kevin@hotmail.com",
  3215. - "fecha_creacion": "2016-07-22T22:09:15.115Z",
  3216. - "fecha_modificacion": "2016-07-22T22:09:15.115Z",
  3217. - "fk_persona": 2,
  3218. - "propiedad": "EMAIL"
  3219. - },
  3220. - {
  3221. - "_id": 2,
  3222. - "valor": "daniel@daniel.com",
  3223. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  3224. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  3225. - "fk_persona": 1,
  3226. - "propiedad": "EMAIL"
  3227. - },
  3228. - {
  3229. - "_id": 3,
  3230. - "valor": "abc@gmail.com",
  3231. - "fecha_creacion": "2016-03-16T22:08:55.216Z",
  3232. - "fecha_modificacion": "2016-03-16T22:08:55.216Z",
  3233. - "fk_persona": 10,
  3234. - "propiedad": "EMAIL"
  3235. - }
  3236. - ]
  3237. - }
  3238. -
  3239. -Busca las personas que en el atributo "valor" contenga la palabra "adsib"
  3240. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  3241. -
  3242. -**URL**
  3243. -::
  3244. -
  3245. - /datosPersonas?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  3246. -
  3247. -**Parámetros usados**
  3248. -
  3249. -============ ===========================================
  3250. -**Nombre** **Valor enviado**
  3251. -============ ===========================================
  3252. -`buscar` ::
  3253. -
  3254. - [{"en":"valor","palabra":"adsib"}]
  3255. -============ ===========================================
  3256. -
  3257. -**Ejemplo:**
  3258. -::
  3259. -
  3260. - /datosPersonas?buscar=%7B%22en%22:%22valor%22,%22palabra%22:%22adsib%22%7D
  3261. -
  3262. -**Respuesta:**
  3263. -
  3264. -.. code:: json
  3265. -
  3266. - {
  3267. - "count":4,"rows":
  3268. - [
  3269. - {
  3270. - "_id": 4,
  3271. - "valor": "palvarez@adsib.gob.bo",
  3272. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3273. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3274. - "fk_persona": 5,
  3275. - "propiedad": "EMAIL"
  3276. - }
  3277. - ]
  3278. - }
  3279. -
  3280. -Muestra el detalle de Postulante y Tipos de dato del correo "palvarez@adsib.gob.bo"
  3281. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  3282. -
  3283. -**URL**
  3284. -::
  3285. -
  3286. - /datosPersonas?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D&incluye=%7B%22entidad%22:%22valor3%22%7D&incluye=%7B%22entidad%22:%22valor4%22%7D
  3287. -
  3288. -**Parámetros usados**
  3289. -
  3290. -============ ===========================================
  3291. -**Nombre** **Valor enviado**
  3292. -============ ===========================================
  3293. -`buscar` ::
  3294. -
  3295. - [{"en":"valor","palabra":"adsib"}]
  3296. -
  3297. -`incluye` ::
  3298. -
  3299. - [{"entidad":"Persona"},{"entidad":"TipoDato"}]
  3300. -============ ===========================================
  3301. -
  3302. -**Ejemplo:**
  3303. -::
  3304. -
  3305. - /datosPersonas?buscar=%7B%22en%22:%22valor%22,%22palabra%22:%22email%22%7D&incluye=%7B%22entidad%22:%22Persona%22%7D&incluye=%7B%22entidad%22:%22TipoDato%22%7D
  3306. -
  3307. -**Respuesta:**
  3308. -
  3309. -.. code:: json
  3310. -
  3311. - {
  3312. - "count": 1,
  3313. - "rows": [
  3314. - {
  3315. - "_id": 4,
  3316. - "valor": "palvarez@adsib.gob.bo",
  3317. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3318. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3319. - "fk_persona": 5,
  3320. - "propiedad": "EMAIL",
  3321. - "Persona": {
  3322. - "_id": 23,
  3323. - "nombres": "Victor Hugo",
  3324. - "apellidos": "Suarez Perez",
  3325. - "ci": "45678912",
  3326. - "fecha_creacion": "2016-06-01T13:13:21.827Z",
  3327. - "fecha_modificacion": "2016-06-01T13:13:21.827Z"
  3328. - },
  3329. - "TipoDato": {
  3330. - "propiedad": "EMAIL",
  3331. - "nombre": "correo electronico",
  3332. - "createdAt": "2016-06-01T13:15:21.318Z",
  3333. - "updatedAt": "2016-06-01T13:15:21.318Z",
  3334. - "deletedAt": null
  3335. - }
  3336. - }
  3337. - ]
  3338. - }
  3339. -
  3340. -Respuesta de error
  3341. -``````````````````
  3342. -
  3343. -**Código:** 500
  3344. -
  3345. -**Contenido:**
  3346. -
  3347. -.. code:: json
  3348. -
  3349. - {
  3350. - "error":"Ocurrio un problema inesperado en el servidor"
  3351. - }
  3352. -
  3353. -Observaciones
  3354. -`````````````
  3355. -- Cuando no existen datos almacenados en la base de datos retorna un array vacio
  3356. -- El parámetro 'orden' depende de 'ordenarPor'
  3357. -- El parámetro 'pagina' muestra 15 datos de postulantes por defecto
  3358. -- Solo se puede hacer "incluye" con las entidades "tipo_dato" y "postulante"
  3359. -
  3360. -----
  3361. -
  3362. -Crear un dato de persona
  3363. +Formato URL
  3364. ------------------------
  3365. -
  3366. -URL
  3367. -```
  3368. -::
  3369. -
  3370. - /datosPersonas
  3371. -
  3372. -Método
  3373. -``````
  3374. -``POST``
  3375. -
  3376. -Parámetros del body
  3377. -```````````````````
  3378. -**Ejemplo:**
  3379. -
  3380. -.. code:: json
  3381. -
  3382. - {
  3383. - "valor":"email@email.net",
  3384. - "propiedad":"EMAIL",
  3385. - "fk_persona":"1"
  3386. - }
  3387. -
  3388. -Respuesta correcta
  3389. -``````````````````
  3390. -
  3391. -**Código:** 201
  3392. -
  3393. -**Contenido:**
  3394. -
  3395. -.. code:: json
  3396. -
  3397. - {
  3398. - "_id": 3,
  3399. - "valor": "email@email.net",
  3400. - "propiedad": "EMAIL",
  3401. - "fk_persona": 1,
  3402. - "fecha_modificacion": "2016-03-15T22:59:34.162Z",
  3403. - "fecha_creacion": "2016-03-15T22:59:34.162Z"
  3404. - }
  3405. -
  3406. -Respuesta de error
  3407. -``````````````````
  3408. -
  3409. -**Código:** 400
  3410. -
  3411. -**Contenido:**
  3412. -
  3413. -.. code:: json
  3414. -
  3415. - {
  3416. - "name": "SequelizeValidationError",
  3417. - "message": "Validation error: Por favor ingrese un comentario",
  3418. - "errors": [
  3419. - {
  3420. - "message": "Por favor ingrese un comentario",
  3421. - "type": "Validation error",
  3422. - "path": "contenido",
  3423. - "value": {},
  3424. - "__raw": {}
  3425. - }
  3426. - ]
  3427. - }
  3428. -
  3429. -----
  3430. -
  3431. -Mostrar un dato de persona
  3432. --------------------------------
  3433. -
  3434. -URL
  3435. -```
  3436. -::
  3437. -
  3438. - /datosPersonas/:id
  3439. -
  3440. -Método
  3441. -``````
  3442. -``GET``
  3443. -
  3444. -Parámetros de la URL
  3445. -````````````````````
  3446. -
  3447. -**Parámetro requerido:**
  3448. -
  3449. -============ ============== ================================================
  3450. -**Nombre** **Tipo** **Descripción**
  3451. -============ ============== ================================================
  3452. -`id` Integer Identificador único del registro en la entidad.
  3453. -============ ============== ================================================
  3454. -
  3455. -**Ejemplo:**
  3456. -::
  3457. -
  3458. - id=2
  3459. -
  3460. -Respuesta correcta
  3461. -``````````````````
  3462. -
  3463. -**Código:** 200
  3464. -
  3465. -**Contenido:**
  3466. -
  3467. -.. code:: json
  3468. -
  3469. - {
  3470. - "_id": 2,
  3471. - "valor": "daniel@daniel.com",
  3472. - "fecha_creacion": "2016-02-14T22:03:48.216Z",
  3473. - "fecha_modificacion": "2016-02-14T22:03:48.216Z",
  3474. - "fk_persona": 1,
  3475. - "propiedad": "EMAIL"
  3476. - }
  3477. -
  3478. -Respuesta de error
  3479. -``````````````````
  3480. -
  3481. -**Código:** 404
  3482. -
  3483. -**Contenido:**
  3484. -
  3485. -.. code:: json
  3486. -
  3487. - {
  3488. - "message": "Entidad no encontrada"
  3489. - }
  3490. -
  3491. -----
  3492. -
  3493. -Editar un dato de persona
  3494. --------------------------
  3495. -
  3496. -URL
  3497. -```
  3498. -::
  3499. -
  3500. - /datosPersonas/
  3501. -
  3502. -Método
  3503. -``````
  3504. -``PUT``
  3505. -
  3506. -Parámetros de la URL
  3507. -````````````````````
  3508. -
  3509. -**Parámetro requerido:**
  3510. -
  3511. -============ ============== ================================================
  3512. -**Nombre** **Tipo** **Descripción**
  3513. -============ ============== ================================================
  3514. -`id` Integer Identificador único del registro en la entidad.
  3515. -============ ============== ================================================
  3516. -
  3517. -**Ejemplo:**
  3518. -::
  3519. -
  3520. - id=3
  3521. -
  3522. -Parámetros del body
  3523. -```````````````````
  3524. -**Ejemplo:**
  3525. -
  3526. -.. code:: json
  3527. -
  3528. - {
  3529. - "valor": "email@gmail.com"
  3530. - }
  3531. -
  3532. -Respuesta correcta
  3533. -``````````````````
  3534. -
  3535. -**Código:** 200
  3536. -
  3537. -**Contenido:**
  3538. -
  3539. -.. code:: json
  3540. -
  3541. - {
  3542. - "_id": 3,
  3543. - "valor": "email@gmail.com",
  3544. - "propiedad": "EMAIL",
  3545. - "fk_persona": 1,
  3546. - "fecha_modificacion": "2016-03-15T22:59:34.162Z",
  3547. - "fecha_creacion": "2016-03-15T22:59:34.162Z"
  3548. - }
  3549. -
  3550. -Respuesta de error
  3551. -``````````````````
  3552. -
  3553. -**Código:** 404
  3554. -
  3555. -**Contenido:**
  3556. -
  3557. -.. code:: json
  3558. -
  3559. - {
  3560. - "message": "Entidad no encontrada"
  3561. - }
  3562. -
  3563. -
  3564. -**Código:** 400
  3565. -
  3566. -**Contenido:**
  3567. -
  3568. -.. code:: json
  3569. -
  3570. - {
  3571. - "name": "SequelizeValidationError",
  3572. - "message": "Validation error: Ingrese el dato para la persona.",
  3573. - "errors": [
  3574. - {
  3575. - "message": "Ingrese el dato para la persona.",
  3576. - "type": "Validation error",
  3577. - "path": "valor",
  3578. - "value": {},
  3579. - "__raw": {}
  3580. - }
  3581. - ]
  3582. - }
  3583. -
  3584. -----
  3585. -
  3586. -Eliminar un dato de persona
  3587. ----------------------------
  3588. -
  3589. -URL
  3590. -```
  3591. -::
  3592. -
  3593. - /datosPersonas/
  3594. -
  3595. -Método
  3596. -``````
  3597. -``DELETE``
  3598. -
  3599. -Parámetros de la URL
  3600. -````````````````````
  3601. -
  3602. -**Parámetro requerido:**
  3603. -
  3604. -============ ============== ================================================
  3605. -**Nombre** **Tipo** **Descripción**
  3606. -============ ============== ================================================
  3607. -`id` Integer Identificador único del registro en la entidad.
  3608. -============ ============== ================================================
  3609. -
  3610. -**Ejemplo:**
  3611. -::
  3612. -
  3613. - id=187
  3614. -
  3615. -Respuesta correcta
  3616. -``````````````````
  3617. -
  3618. -**Código:** 204
  3619. -
  3620. -Respuesta de error
  3621. -``````````````````
  3622. -
  3623. -**Código:** 404
  3624. -
  3625. -**Contenido:**
  3626. -
  3627. -.. code:: json
  3628. -
  3629. - {
  3630. - "message": "Entidad no encontrada"
  3631. - }
  3632. -
  3633. -----
  3634. -
  3635. -Muestra detalles de un dato de persona
  3636. ---------------------------------------
  3637. -
  3638. -URL
  3639. -```
  3640. -::
  3641. -
  3642. - /datosPersonas/obtieneDato/:id
  3643. -
  3644. -Método
  3645. -``````
  3646. -``GET``
  3647. -
  3648. -Parámetros de la URL
  3649. -````````````````````
  3650. -
  3651. -**Parámetro requerido:**
  3652. -
  3653. -============ ============== ================================================
  3654. -**Nombre** **Tipo** **Descripción**
  3655. -============ ============== ================================================
  3656. -`id` Integer Identificador único del registro en la entidad.
  3657. -============ ============== ================================================
  3658. -
  3659. -**Ejemplo:**
  3660. -::
  3661. -
  3662. - id=4
  3663. -
  3664. -Respuesta correcta
  3665. -``````````````````
  3666. -
  3667. -**Código:** 200
  3668. -
  3669. -**Contenido:**
  3670. -
  3671. -.. code:: json
  3672. -
  3673. - [
  3674. - {
  3675. - "propiedad": "EMAIL",
  3676. - "nombre": "correo electronico",
  3677. - "createdAt": "2016-06-01T13:15:21.318Z",
  3678. - "updatedAt": "2016-06-01T13:15:21.318Z",
  3679. - "deletedAt": null,
  3680. - "DatoPersona": {
  3681. - "_id": 4,
  3682. - "valor": "palvarez@adsib.gob.bo",
  3683. - "fecha_creacion": "2016-04-18T22:01:28.110Z",
  3684. - "fecha_modificacion": "2016-04-18T22:01:28.110Z",
  3685. - "fk_persona": 5,
  3686. - "propiedad": "EMAIL"
  3687. - }
  3688. - }
  3689. - ]
  3690. -
  3691. -Respuesta de error
  3692. -``````````````````
  3693. -
  3694. -**Código:** 404
  3695. -
  3696. -**Contenido:**
  3697. -
  3698. -.. code:: json
  3699. -
  3700. - {
  3701. - "message": "Entidad no encontrada"
  3702. - }
  3703. -
  3704. -----
  3705. ++-----------------+-------------------------+
  3706. +|**Método HTTP** |**Significado** |
  3707. ++=================+=========================+
  3708. +|`GET` | Obtiene un recurso |
  3709. ++-----------------+-------------------------+
  3710. +|`POST` | Crea un recurso |
  3711. ++-----------------+-------------------------+
  3712. +|`PUT` | Actualiza un recurso |
  3713. ++-----------------+-------------------------+
  3714. +|`DELETE` | Borra un recurso |
  3715. ++-----------------+-------------------------+
  3716. +
  3717. +Ejemplo
  3718. +''''''''''''
  3719. +
  3720. +**Contenido Body**
  3721. +
  3722. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  3723. +
  3724. +.. code:: json
  3725. +
  3726. + {
  3727. + "valor": "(591) 777-000007",
  3728. + "fecha_creacion": "2016-04-27T20:58:20.042Z",
  3729. + "fecha_modificacion": "2016-04-27T20:58:20.042Z",
  3730. + "fk_persona": 1091, //Sylvain Damien Lesage
  3731. + "propiedad": "TEL-CEL" //Teléfono Celular
  3732. + }
  3733. +
  3734. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  3735. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  3736. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  3737. +| /datosPersonas | Obtiene el listado de todos los Datos Persona | Crea un registro de Datos Persona | | |
  3738. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  3739. +| /datosPersonas/:id | Obtiene el Datos Persona identificado como :id | | Actualiza registro :id de Datos Persona | Elimina registro :id de Datos Persona |
  3740. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  3741. +
  3742. +
  3743. +Respuestas
  3744. +----------
  3745. +
  3746. ++------------------+----------------------------------------------------------------------------------------------+
  3747. +| **Código HTTP** | **Descripción** |
  3748. ++==================+==============================================================================================+
  3749. +| `200` | Ok |
  3750. ++------------------+----------------------------------------------------------------------------------------------+
  3751. +| `201` | Creado |
  3752. ++------------------+----------------------------------------------------------------------------------------------+
  3753. +| `400` | Parámetros incorrectos en la entrada |
  3754. ++------------------+----------------------------------------------------------------------------------------------+
  3755. +| `401` | Token de acceso expirado o invalido |
  3756. ++------------------+----------------------------------------------------------------------------------------------+
  3757. +| `404` | Recurso no encontrado |
  3758. ++------------------+----------------------------------------------------------------------------------------------+
  3759. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  3760. ++------------------+----------------------------------------------------------------------------------------------+
  3761. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  3762. ++------------------+----------------------------------------------------------------------------------------------+
  3763. +| `500` | Error interno del servidor |
  3764. ++------------------+----------------------------------------------------------------------------------------------+
  3765. diff --git a/docs/documentacion/INSTALL.rst b/docs/documentacion/INSTALL.rst
  3766. index 4879459..e756f02 100644
  3767. --- a/docs/documentacion/INSTALL.rst
  3768. +++ b/docs/documentacion/INSTALL.rst
  3769. @@ -2,22 +2,21 @@ Instalación
  3770. ===============
  3771.  
  3772. Prerrequisitos
  3773. ----------------
  3774. +------------------------------
  3775.  
  3776. -La siguiente instalación y configuración realizado en Sistema Operativo
  3777. -Debian Jessie
  3778. +La siguiente instalación y configuración realizado en Sistema Operativo Debian Jessie
  3779.  
  3780. **Creacion de Usuario en Sistema Operativo**
  3781.  
  3782. .. code:: sh
  3783.  
  3784. - $ sudo adduser usuarioPersonal
  3785. + $ sudo adduser usuario_proyecto
  3786.  
  3787. **Agregar Usuario al grupo sudo del Sistema Operativo**
  3788.  
  3789. .. code:: sh
  3790.  
  3791. - $ sudo adduser usuarioPersonal sudo
  3792. + $ sudo adduser usuario_proyecto sudo
  3793.  
  3794. **Instalando GIT**
  3795.  
  3796. @@ -34,42 +33,46 @@ Para la instalación realizar:
  3797.  
  3798. **Instalando nodejs y npm**
  3799.  
  3800. - Node.js es un entorno de desarrollo basado en JavaScript que permite
  3801. - la ejecución de servicios y eventos del lado del servidor. Existen
  3802. - múltiples librerias que podriamos incorporar a Node,js, esto lo
  3803. - haremos a través de su administrador NPM.
  3804. +Node.js es un entorno de desarrollo basado en JavaScript que permite la ejecución de servicios y eventos del lado del servidor. Existen múltiples librerías que podríamos incorporar a Node,js, esto lo haremos a través de su administrador **NPM**.
  3805.  
  3806. - **Instalar Curl**\ \*
  3807.  
  3808. - Durante el proceso de instalación necesitaremos este binario.
  3809. +**Instalar Curl**
  3810. +
  3811. +Durante el proceso de instalación necesitaremos este binario.
  3812.  
  3813. .. code:: sh
  3814.  
  3815. $ sudo apt-get install curl
  3816.  
  3817. - **Añadiendo los repositorios de NodeSource**\ \*
  3818.  
  3819. - Para añadir los repositorios de node.js version 4.x debemos de
  3820. - ejecutar:
  3821. +**Añadiendo los repositorios de NodeSource**
  3822. +
  3823. +Para añadir los repositorios de node.js version 4.x debemos de ejecutar:
  3824.  
  3825. .. code:: sh
  3826.  
  3827. - $ sudo curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
  3828. + $ sudo curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
  3829. +
  3830.  
  3831. - **Instalando Node.js**\ \*
  3832. +**Instalando Node.js**
  3833.  
  3834. - Ahora realizaremos la instalacion de node v4.4.0
  3835. +Ahora realizaremos la instalación de node v4.4.0
  3836.  
  3837. .. code:: sh
  3838.  
  3839. $ sudo apt-get install -y nodejs
  3840.  
  3841. - **Instalando NPM**\ \*
  3842. +**Instalando NPM**
  3843.  
  3844. - npm(node package manager) es el gestor de paquetes de Node.js, nos
  3845. - permitira descargar librerias y enlazarlas.
  3846. +npm(node package manager) es el gestor de paquetes de Node.js, nos permitira descargar librerias y enlazarlas.
  3847.  
  3848. - Debemos de seguir de la sigueinte manera:
  3849. +Antes debemos de hacer la instalación de paquetes necesarios para un copilado correcto.
  3850. +
  3851. +.. code:: sh
  3852. +
  3853. + $ sudo apt-get install build-essential
  3854. +
  3855. +Debemos de seguir de la siguiente manera:
  3856.  
  3857. .. code:: sh
  3858.  
  3859. @@ -77,7 +80,7 @@ Para la instalación realizar:
  3860. $ cd npm
  3861. $ sudo make install
  3862.  
  3863. - Para verificar si esta instalado correctamente:
  3864. +Para verificar si esta instalado correctamente:
  3865.  
  3866. .. code:: sh
  3867.  
  3868. @@ -92,53 +95,64 @@ unitarias, y mucho más.
  3869.  
  3870. $ sudo npm install -g grunt-cli
  3871.  
  3872. +Backend-End
  3873. +---------------------------------------
  3874. +
  3875. +**Instalando SASS**
  3876. +
  3877. +.. code:: sh
  3878. +
  3879. + $ sudo gem install sass
  3880. +
  3881. **Instalando PostgreSQL**
  3882.  
  3883. +
  3884. PostgreSQL es un potente sistema de base de datos objeto-relacional de
  3885. código abierto.
  3886.  
  3887. -***Instalación***
  3888. +- Instalación
  3889.  
  3890. .. code:: sh
  3891.  
  3892. $ sudo apt-get install postgresql postgresql-client postgresql-contrib
  3893.  
  3894. -***Configuración*** Para poder realizar operaciones relacionadas con
  3895. -PostgreSQL: >
  3896. +- Configuración
  3897.  
  3898. -.. code:: sh
  3899. +Para poder realizar operaciones relacionadas con
  3900.  
  3901. +.. code:: sql
  3902. +
  3903. + PostgreSQL: >
  3904. $ sudo su - postgres
  3905.  
  3906. Creando usuario para el sistema:
  3907.  
  3908. -.. code:: sqldb
  3909. +.. code:: sql
  3910.  
  3911. postgres=# CREATE USER usuarioPersonal PASSWORD 'password';
  3912.  
  3913. Cambiando privilegios de usuario:
  3914.  
  3915. -.. code:: sqlDB
  3916. +.. code:: sql
  3917.  
  3918. postgres=# ALTER ROLE usuarioPersonal WITH SUPERUSER;
  3919.  
  3920. Creando la Base de Datos para el sistema
  3921.  
  3922. -.. code:: sqldb
  3923. +.. code:: sql
  3924.  
  3925. postgres=# CREATE DATABASE moduloPersonalDb WITH OWNER usuarioPersonal;
  3926.  
  3927. -Clonar repositorio
  3928. ----------------
  3929. +**Clonar repositorio**
  3930.  
  3931. .. code:: sh
  3932.  
  3933. - $ sudo su - usuarioPersonal
  3934. + $ sudo su - usuario_proyecto
  3935. $ cd ~
  3936. $ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonal.git
  3937. $ cd ModuloPersonal
  3938.  
  3939. -Para instalar las dependecias del servidor
  3940. +Para instalar las dependencias del servidor
  3941.  
  3942. .. code:: sh
  3943.  
  3944. @@ -150,8 +164,55 @@ Para iniciar el servidor de desarrollo en el puerto 9000
  3945.  
  3946. $ grunt serve
  3947.  
  3948. -Instalacion y configuracion de servidor NGinx
  3949. ----------------
  3950. +
  3951. +Front-End
  3952. +---------------------------------------
  3953. +
  3954. +**Instalando BOWER**
  3955. +
  3956. +Bower te permite administrar los componentes que contienen HTML, CSS, JavaScript, fuentes e incluso archivos de imagen. Bower no concatenar o minify código o hacer cualquier otra cosa - sólo instala las versiones correctas de los paquetes que necesita y sus dependencias.
  3957. +
  3958. +.. code:: sh
  3959. +
  3960. + $ npm install -g bower
  3961. +
  3962. +**Instalando Ruby**
  3963. +
  3964. +Un lenguaje de programación dinámico y de código abierto.
  3965. +
  3966. +.. code:: sh
  3967. +
  3968. + $ sudo apt-get install ruby-full
  3969. +
  3970. +**Clonar repositorio**
  3971. +
  3972. +.. code:: sh
  3973. +
  3974. + $ sudo su - usuarioPersonal
  3975. + $ cd ~
  3976. + $ git clone git@gitlab.geo.gob.bo:SistemaGestionAdministrativa/ModuloPersonalCliente.git
  3977. + $ cd ModuloPersonal
  3978. +
  3979. +Para instalar las dependencias del servidor
  3980. +
  3981. +.. code:: sh
  3982. +
  3983. + $ npm install
  3984. +
  3985. +Para ara instalar las dependecias del cliente
  3986. +
  3987. +.. code:: sh
  3988. +
  3989. + $ bower install
  3990. +
  3991. +Para iniciar el servidor de desarrollo en el puerto 9000
  3992. +
  3993. +.. code:: sh
  3994. +
  3995. + $ grunt serve
  3996. +
  3997. +Servidor NGinx
  3998. +------------------------------------------------------------
  3999.  
  4000. Servidor nginx (pronunciado en inglés “engine X”) es un servidor
  4001. web/proxy inverso ligero de alto rendimiento, optimizado para
  4002. @@ -170,11 +231,7 @@ para la edición:
  4003.  
  4004. $ sudo nano /etc/nginx/sites-available/default
  4005.  
  4006. -Insertar la siguiente configuración. Asegúrese de sustituir su propio
  4007. -nombre de dominio para el server (o la dirección IP si usted no tiene un
  4008. -dominio configurado), y la aplicación dirección IP-Privada del servidor
  4009. -para el APP\_PRIVATE\_IP\_ADDRESS . Además, cambiar el puerto ( 9000 )
  4010. -si la aplicación está configurado para escuchar en un puerto diferente:
  4011. +Insertar la siguiente configuración. Asegúrese de sustituir su propio nombre de dominio para el server (o la dirección IP si usted no tiene un dominio configurado), y la aplicación dirección IP-Privada del servidor para el APP_PRIVATE_IP_ADDRESS . Además, cambiar el puerto ( 9000 ) si la aplicación está configurado para escuchar en un puerto diferente:
  4012.  
  4013. .. code:: sh
  4014.  
  4015. @@ -193,16 +250,10 @@ si la aplicación está configurado para escuchar en un puerto diferente:
  4016. }
  4017. }
  4018.  
  4019. -Una vez que haya terminado de añadir los bloques de localización para
  4020. -sus aplicaciones, guardar y salir. En el servidor, reiniciar Nginx:
  4021. +Una vez que haya terminado de añadir los bloques de localización para sus aplicaciones, guardar y salir. En el servidor, reiniciar Nginx:
  4022.  
  4023. .. code:: sh
  4024.  
  4025. $ sudo /et c/init.d/nginx restart
  4026.  
  4027. -Esto configura la web del servidor para responder a las solicitudes en
  4028. -su raíz. Suponiendo que nuestro servidor está disponible en example.com
  4029. -, el acceso a http://sitio-de-prueba.gob.bo/ a través de un navegador
  4030. -web que enviar la solicitud a la dirección IP privada del servidor de
  4031. -aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js
  4032. -solicitud.
  4033. +Esto configura la web del servidor para responder a las solicitudes en su raíz. Suponiendo que nuestro servidor está disponible en example.com, el acceso a http://sitio-de-prueba.gob.bo/ a través de un navegador web que enviar la solicitud a la dirección IP privada del servidor de aplicaciones en el puerto 9000 , que se recibió y respondió a la Node.js solicitud.
  4034. diff --git a/docs/documentacion/README.rst b/docs/documentacion/README.rst
  4035. index 441b5bb..2092067 100644
  4036. --- a/docs/documentacion/README.rst
  4037. +++ b/docs/documentacion/README.rst
  4038. @@ -1,14 +1,24 @@
  4039. Readme
  4040. ===============
  4041.  
  4042. -Este es el modulo de personal del sistema de gestion administrativa
  4043. +Este es el modulo de contratación pertenece al sistema de gestión administrativa.
  4044.  
  4045. -Desarrolladores
  4046. ----------------
  4047. +Equipo
  4048. +------------------------
  4049.  
  4050. -- D'jalmar
  4051. -- David
  4052. -- Gustavo
  4053. ++-------------------------+--------------------------+
  4054. +|**Programador** |**Correo Electrónico** |
  4055. ++=========================+==========================+
  4056. +|`D'jalmar Gutierrez` | <dgutierrez@adsib.gob.bo>|
  4057. ++-------------------------+--------------------------+
  4058. +|`Teodoro Nina` | <tnina@adsib.gob.bo> |
  4059. ++-------------------------+--------------------------+
  4060. +
  4061. ++-------------------------+-------------------------+
  4062. +|**Pasante** |**Correo Electrónico** |
  4063. ++=========================+=========================+
  4064. +|`Gustavo Callejas` | <gcallejas@adsib.gob.bo>|
  4065. ++-------------------------+-------------------------+
  4066.  
  4067. Prerequisitos
  4068. ---------------
  4069. @@ -18,23 +28,22 @@ Prerequisitos
  4070. - `Grunt <http://gruntjs.com/>`__ (``npm install --global grunt-cli``)
  4071. - `Postgresql <http://www.postgresql.org.es/>`__
  4072.  
  4073. -Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes comandos en la terminal
  4074. +Ejecución
  4075. ---------------
  4076.  
  4077. +Para iniciar el proyecto en desarrollo se deben ejecutar los siguientes comandos en la terminal
  4078. +
  4079. 1. Ejecutar ``npm install`` para instalar las dependecias del servidor.
  4080.  
  4081. 2. Ejecutar ``grunt serve`` para iniciar el servidor de desarrollo. Debe
  4082. iniciar automaticamente el explorador.
  4083.  
  4084. -Compilacion y desarrollo
  4085. -------------------------
  4086. +Compilación y Desarrollo
  4087. +----------------------------
  4088.  
  4089. -Ejecutar ``grunt build`` para compilar el proyecto, el proyecto
  4090. -compilado se encuentra en la carpeta ``dist`` luego ejecutar
  4091. -``grunt serve`` para una vista previa.
  4092. +Ejecutar ``grunt build`` para compilar el proyecto, y el resultado de esa compilación se encuentra en la carpeta ``dist`` luego ejecutar **grunt serve** para una vista previa.
  4093.  
  4094. -Tests
  4095. +Test
  4096. -----
  4097.  
  4098. -Ejecutar ``npm test`` para ejecutar todos los test(unitarios y de
  4099. -integracion) del proyecto
  4100. +Ejecutar ``npm test`` para ejecutar todos los test(unitarios y de integración) del proyecto
  4101. diff --git a/docs/entidad/entidad.rst b/docs/entidad/entidad.rst
  4102. index 0f3fddb..ece343e 100644
  4103. --- a/docs/entidad/entidad.rst
  4104. +++ b/docs/entidad/entidad.rst
  4105. @@ -36,23 +36,27 @@ Contenido en data del cuerpo para realizar el creado y actualización de un regi
  4106. }
  4107.  
  4108.  
  4109. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4110. -|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  4111. -+============================================+=====================================================================================================+====================================================+=====================================================+==============================================+
  4112. -| `/entidades` | Obtiene el listado de todos las entidades | Crea un registro de entidad | | |
  4113. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4114. -| `/entidades/:id` | Obtiene la entidad identificado como :id | | Actualiza la entidad identificado como :id | Elimina la entidad identificado como :id |
  4115. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4116. -| `/entidades/:id/organigrama` | Obtiene el organigrama de la entidad identificado como :id | | | |
  4117. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4118. -| `/entidades/:id/oficinas` | Obtiene el listado de las oficinas de una entidad identificado como :id | | | |
  4119. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4120. -| `/entidades/:id/unidadesOrganizacionales` | Obtiene el listado de las unidades organizacionales de una entidad identificado como :id | | | |
  4121. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4122. -| `/entidades/:id/convocatorias` | Obtiene el listado de las convocatorias de una entidad identificado como :id | | | |
  4123. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4124. -| `/entidades/:id/cargosDisponibles` | Obtiene el listado de los cargos disponibles de una entidad identificado como :id | | | |
  4125. -+--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------+
  4126. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4127. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  4128. ++============================================+=====================================================================================================+====================================================+====================================================================================================+==============================================+
  4129. +| `/entidades` | Obtiene el listado de todos las Entidades | Crea un registro de entidad | | |
  4130. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4131. +| `/entidades/:id` | Obtiene la entidad identificado como :id | | Actualiza la Entidad identificado como :id | Elimina la Entidad identificado como :id |
  4132. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4133. +| `/entidades/:id/organigrama` | Obtiene el organigrama de la Entidad identificado como :id | | | |
  4134. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4135. +| `/entidades/:id/oficinas` | Obtiene el listado de las oficinas de una Entidad identificado como :id | | | |
  4136. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4137. +| `/entidades/:id/unidadesOrganizacionales` | Obtiene el listado de las Unidades Organizacionales de una Entidad identificado como :id | | | |
  4138. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4139. +| `/entidades/:id/convocatorias` | Obtiene el listado de las convocatorias de una entidad identificado como :id | | | |
  4140. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4141. +| `/entidades/:id/cargosDisponibles` | Obtiene el listado de los cargos disponibles de una Entidad identificada como :id | | | |
  4142. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4143. +| `/entidades/:id/tiposCargo` | Obtiene el listado de los tipos cargo disponibles de una Entidad identificada como :id | | | |
  4144. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4145. +| `/entidades/:id/ordenarUnidades` | | | Actualiza orden de Unidades Organizacionales de una entidad identificada como :id | |
  4146. ++--------------------------------------------+-----------------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------------------------------------------------+----------------------------------------------+
  4147.  
  4148.  
  4149. Tabla de parámetros opcionales de la URL para peticines GET
  4150. diff --git a/docs/index.rst b/docs/index.rst
  4151. index 87753fc..6283e73 100644
  4152. --- a/docs/index.rst
  4153. +++ b/docs/index.rst
  4154. @@ -32,17 +32,17 @@ Contenido:
  4155. entidad/entidad.rst
  4156. etapa/etapa.rst
  4157. evaluacion/evaluacion.rst
  4158. - evaluacionCargoEtapa/evaluacionCargoEtapa.rst
  4159. - migracionMoodle/migracionMoodle.servicio.web.rst
  4160. - migracionMoodle/migracionMoodle.mysql.moodle.rst
  4161. + migracionMoodle/migracionUsuarioMoodle.rst
  4162. + migracionMoodle/migracionWebServiceMoodle.rst
  4163. oficina/oficina.rst
  4164. oficinaUnidad/oficinaUnidad.rst
  4165. persona/persona.rst
  4166. postulacion/postulacion.rst
  4167. + reserva/reserva.rst
  4168. tag/tag.rst
  4169. tagPersona/tagPersona.rst
  4170. - tipoCargo/tipoCargo.rst
  4171. - tipoDato/tipoDato.rst
  4172. + tipo_dato/tipo_dato.rst
  4173. + tipoCargo/tipoCargoo.rst
  4174. tipoEntidad/tipoEntidad.rst
  4175. unidadOrganizacional/unidadOrganizacional.rst
  4176.  
  4177. @@ -50,12 +50,12 @@ Contenido:
  4178. :maxdepth: 1
  4179. :caption: Modelos
  4180.  
  4181. - modelo_datos/modelo_datos.rst
  4182. + modelos_db/modelo_db.rst
  4183.  
  4184. .. toctree::
  4185. :maxdepth: 1
  4186. :caption: Otros
  4187.  
  4188. - test/test.rst
  4189. - mockups/mockups.rst
  4190. - cambios/cambios.rst
  4191. + otros/guia_test.rst
  4192. + otros/guia_mockup.rst
  4193. + otros/licencia.rst
  4194. diff --git a/docs/migracionMoodle/migracionMoodle.mysql.moodle.rst b/docs/migracionMoodle/migracionUsuarioMoodle.rst
  4195. similarity index 98%
  4196. rename from docs/migracionMoodle/migracionMoodle.mysql.moodle.rst
  4197. rename to docs/migracionMoodle/migracionUsuarioMoodle.rst
  4198. index 0646255..206c528 100644
  4199. --- a/docs/migracionMoodle/migracionMoodle.mysql.moodle.rst
  4200. +++ b/docs/migracionMoodle/migracionUsuarioMoodle.rst
  4201. @@ -4,7 +4,7 @@ Migrar
  4202. El presente servicio realiza la migración de todos los datos del postulante (usuario).
  4203.  
  4204. Prerrequisitos de configuración
  4205. --------------------------------
  4206. +----------------------------------------------
  4207.  
  4208. **Tablas de extracción de Datos [mdl_user, mdl_tag_instance, mdl_tag]**
  4209.  
  4210. diff --git a/docs/migracionMoodle/migracionModle.servicio.web.rst b/docs/migracionMoodle/migracionWebServiceMoodle.rst
  4211. similarity index 100%
  4212. rename from docs/migracionMoodle/migracionModle.servicio.web.rst
  4213. rename to docs/migracionMoodle/migracionWebServiceMoodle.rst
  4214. diff --git a/docs/modelo_db/bd_26072016.pdf b/docs/modelo_db/bd_26072016.pdf
  4215. new file mode 100644
  4216. index 0000000..2ae912e
  4217. Binary files /dev/null and b/docs/modelo_db/bd_26072016.pdf differ
  4218. diff --git a/docs/modelo_datos/modelo_datos.rst b/docs/modelo_db/modelo_db.rst
  4219. similarity index 50%
  4220. rename from docs/modelo_datos/modelo_datos.rst
  4221. rename to docs/modelo_db/modelo_db.rst
  4222. index 6fc0571..ef6f451 100644
  4223. --- a/docs/modelo_datos/modelo_datos.rst
  4224. +++ b/docs/modelo_db/modelo_db.rst
  4225. @@ -1,7 +1,5 @@
  4226. Modelos (BD)
  4227. ==============
  4228.  
  4229. -Modelos del Proyecto
  4230. ---------------------
  4231.  
  4232. -Modelo de la base de datos del proyecto Modulo Personal
  4233. +`Modelado del proyecto <bd_26072016.pdf>`_
  4234. diff --git a/docs/oficina/oficina.rst b/docs/oficina/oficina.rst
  4235. index 451eeb5..8e53c48 100644
  4236. --- a/docs/oficina/oficina.rst
  4237. +++ b/docs/oficina/oficina.rst
  4238. @@ -1,58 +1,51 @@
  4239. Oficina
  4240. -=======
  4241. +====================
  4242.  
  4243. -Mostrar todas las oficinas
  4244. ---------------------------
  4245. +Formato URL
  4246. +------------------------
  4247. ++-----------------+-------------------------+
  4248. +|**Método HTTP** |**Significado** |
  4249. ++=================+=========================+
  4250. +|`GET` | Obtiene un recurso |
  4251. ++-----------------+-------------------------+
  4252. +|`POST` | Crea un recurso |
  4253. ++-----------------+-------------------------+
  4254. +|`PUT` | Actualiza un recurso |
  4255. ++-----------------+-------------------------+
  4256. +|`DELETE` | Borra un recurso |
  4257. ++-----------------+-------------------------+
  4258.  
  4259. -URL
  4260. -```
  4261. -::
  4262. +Ejemplo
  4263. +''''''''''''
  4264.  
  4265. - /oficinas
  4266. +**Contenido Body**
  4267.  
  4268. -Método
  4269. -``````
  4270. -``GET``
  4271. -
  4272. -Respuesta correcta
  4273. -``````````````````
  4274. -
  4275. -**Código:** 200
  4276. -
  4277. -**Contenido:**
  4278. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  4279.  
  4280. .. code:: json
  4281.  
  4282. {
  4283. - "count": 2,
  4284. - "rows": [
  4285. - {
  4286. - "_id": 1,
  4287. - "nombre": "Oficina Central",
  4288. - "pais": "Bolivia",
  4289. - "latitud": -16.85,
  4290. - "longitud": -68.15,
  4291. - "principal": true,
  4292. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4293. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4294. - },
  4295. - {
  4296. - "_id": 2,
  4297. - "nombre": "Dirección de Finanzas",
  4298. - "pais": "Bolivia",
  4299. - "latitud": -16.85,
  4300. - "longitud": -68.15,
  4301. - "principal": false,
  4302. - "fecha_creacion": "2016-04-27T19:01:59.064Z",
  4303. - "fecha_modificacion": "2016-04-27T19:01:59.064Z"
  4304. - }
  4305. - ]
  4306. + "nombre": "Oficina Central",
  4307. + "pais": "Bolivia",
  4308. + "latitud": 16.45,
  4309. + "longitud": 48.67,
  4310. + "principal": true,
  4311. + "fecha_creacion": "2016-07-28T14:12:00.539Z",
  4312. + "fecha_modificacion": "2016-07-28T14:12:00.539Z",
  4313. + "fk_entidad": 109 //ADSIB
  4314. }
  4315.  
  4316. -Parámetros opcionales de la URL
  4317. -```````````````````````````````
  4318. -Tabla de parámetros
  4319. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  4320. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  4321. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  4322. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  4323. +| /oficinas | Obtiene el listado de todos las Oficinas | Crea un registro de Oficina | | |
  4324. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  4325. +| /oficinas/:id | Obtiene la Oficina identificado como :id | | Actualiza registro :id de Oficina | Elimina registro :id de Oficina |
  4326. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  4327. +
  4328. +
  4329. +Tabla de parámetros opcionales de la URL para peticines GET
  4330. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  4331. +-+-----------+------------------+---------------------------------------------------------------------+
  4332. |**Nombre** |**Tipo** |**Descripción** |
  4333. +=+===========+==================+=====================================================================+
  4334. @@ -77,539 +70,25 @@ Tabla de parámetros
  4335. | |`entidad` | String |El nombre de la entidad. |
  4336. +-+-----------+------------------+---------------------------------------------------------------------+
  4337.  
  4338. -Muestra una determinada cantidad de oficinas
  4339. -''''''''''''''''''''''''''''''''''''''''''''
  4340. -
  4341. -**URL**
  4342. -::
  4343. -
  4344. - /oficinas?elementos=valor
  4345. -
  4346. -**Parámetros usados**
  4347. -
  4348. -============ =====================
  4349. -**Nombre** **Valor enviado**
  4350. -============ =====================
  4351. -`elementos` 1
  4352. -============ =====================
  4353. -
  4354. -**Ejemplo:**
  4355. -
  4356. -::
  4357. -
  4358. - /oficinas?elementos=1
  4359. -
  4360. -**Respuesta:**
  4361. -
  4362. -.. code:: json
  4363. -
  4364. - {
  4365. - "count": 2,
  4366. - "rows": [
  4367. - {
  4368. - "_id": 1,
  4369. - "nombre": "Oficina Central",
  4370. - "pais": "Bolivia",
  4371. - "latitud": -16.85,
  4372. - "longitud": -68.15,
  4373. - "principal": true,
  4374. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4375. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4376. - }
  4377. - ]
  4378. - }
  4379. -
  4380. -Muestra las oficinas en una determinada página
  4381. -''''''''''''''''''''''''''''''''''''''''''''''
  4382. -
  4383. -**URL**
  4384. -::
  4385. -
  4386. - /oficinas?pagina=valor
  4387. -
  4388. -**Parámetros usados**
  4389. -
  4390. -============ =====================
  4391. -**Nombre** **Valor enviado**
  4392. -============ =====================
  4393. -`pagina` 1
  4394. -============ =====================
  4395. -
  4396. -**Ejemplo:**
  4397. -::
  4398. -
  4399. - /oficinas?pagina=1
  4400. -
  4401. -**Respuesta:**
  4402. -
  4403. -.. code:: json
  4404. -
  4405. - {
  4406. - "count": 2,
  4407. - "rows": [
  4408. - {
  4409. - "_id": 1,
  4410. - "nombre": "Oficina Central",
  4411. - "pais": "Bolivia",
  4412. - "latitud": -16.85,
  4413. - "longitud": -68.15,
  4414. - "principal": true,
  4415. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4416. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4417. - },
  4418. - {
  4419. - "_id": 2,
  4420. - "nombre": "Dirección de Finanzas",
  4421. - "pais": "Bolivia",
  4422. - "latitud": -16.85,
  4423. - "longitud": -68.15,
  4424. - "principal": false,
  4425. - "fecha_creacion": "2016-04-27T19:01:59.064Z",
  4426. - "fecha_modificacion": "2016-04-27T19:01:59.064Z"
  4427. - }
  4428. - ]
  4429. - }
  4430. -
  4431. -Ordena las oficinas ascendentemente en base a un campo del modelo
  4432. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  4433. -
  4434. -**URL**
  4435. -::
  4436. -
  4437. - /oficinas?ordenarPor=valor
  4438. -
  4439. -**Parámetros usados**
  4440. -
  4441. -============ =====================
  4442. -**Nombre** **Valor enviado**
  4443. -============ =====================
  4444. -`ordenarPor` nombre
  4445. -============ =====================
  4446. -
  4447. -**Ejemplo**
  4448. -::
  4449. -
  4450. - /oficinas?ordenarPor=nombre
  4451. -
  4452. -**Respuesta:**
  4453. -
  4454. -.. code:: json
  4455. -
  4456. - {
  4457. - "count": 2,
  4458. - "rows": [
  4459. - {
  4460. - "_id": 2,
  4461. - "nombre": "Dirección de Finanzas",
  4462. - "pais": "Bolivia",
  4463. - "latitud": -16.85,
  4464. - "longitud": -68.15,
  4465. - "principal": false,
  4466. - "fecha_creacion": "2016-04-27T19:01:59.064Z",
  4467. - "fecha_modificacion": "2016-04-27T19:01:59.064Z"
  4468. - },
  4469. - {
  4470. - "_id": 1,
  4471. - "nombre": "Oficina Central",
  4472. - "pais": "Bolivia",
  4473. - "latitud": -16.85,
  4474. - "longitud": -68.15,
  4475. - "principal": true,
  4476. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4477. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4478. - }
  4479. - ]
  4480. - }
  4481. -
  4482. -Ordena las oficinas descendentemente en base a un campo del modelo
  4483. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  4484. -
  4485. -**URL**
  4486. -::
  4487. -
  4488. - /oficinas?ordenarPor=valor1&orden=true
  4489. -
  4490. -**Parámetros usados**
  4491. -
  4492. -============ =================
  4493. -**Nombre** **Valor enviado**
  4494. -============ =================
  4495. -`ordenarPor` nombre
  4496. -`orden` true
  4497. -============ =================
  4498. -
  4499. -**Ejemplo:**
  4500. -::
  4501. -
  4502. - /oficinas?ordenarPor=nombre&orden=true
  4503. -
  4504. -**Respuesta:**
  4505. -
  4506. -.. code:: json
  4507. -
  4508. - {
  4509. - "count": 2,
  4510. - "rows": [
  4511. - {
  4512. - "_id": 1,
  4513. - "nombre": "Oficina Central",
  4514. - "pais": "Bolivia",
  4515. - "latitud": -16.85,
  4516. - "longitud": -68.15,
  4517. - "principal": true,
  4518. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4519. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4520. - },
  4521. - {
  4522. - "_id": 2,
  4523. - "nombre": "Dirección de Finanzas",
  4524. - "pais": "Bolivia",
  4525. - "latitud": -16.85,
  4526. - "longitud": -68.15,
  4527. - "principal": false,
  4528. - "fecha_creacion": "2016-04-27T19:01:59.064Z",
  4529. - "fecha_modificacion": "2016-04-27T19:01:59.064Z"
  4530. - }
  4531. - ]
  4532. - }
  4533. -
  4534. -Buscar por "palabra" en "campo" de la entidad oficina
  4535. -'''''''''''''''''''''''''''''''''''''''''''''''''''''
  4536. -
  4537. -**URL**
  4538. -::
  4539. -
  4540. - /oficinas?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  4541. -
  4542. -**Parámetros usados**
  4543. -
  4544. -============ ===========================================
  4545. -**Nombre** **Valor enviado**
  4546. -============ ===========================================
  4547. -`buscar` ::
  4548. -
  4549. - [{"en":"nombre","palabra":"Oficina"}]
  4550. -============ ===========================================
  4551. -
  4552. -**Ejemplo**
  4553. -::
  4554. -
  4555. - /oficinas?buscar=%7B%22en%22:%22nombre%22,%22palabra%22:%22Oficina%22%7D
  4556. -
  4557. -**Respuesta:**
  4558. -
  4559. -.. code:: json
  4560. -
  4561. - {
  4562. - "count": 1,
  4563. - "rows": [
  4564. - {
  4565. - "_id": 1,
  4566. - "nombre": "Oficina Central",
  4567. - "pais": "Bolivia",
  4568. - "latitud": -16.85,
  4569. - "longitud": -68.15,
  4570. - "principal": true,
  4571. - "fecha_creacion": "2016-04-27T19:00:35.752Z",
  4572. - "fecha_modificacion": "2016-04-27T19:00:35.752Z"
  4573. - }
  4574. - ]
  4575. - }
  4576. -
  4577. -Respuesta de error
  4578. -``````````````````
  4579. -
  4580. -**Código:** 500
  4581. -
  4582. -**Contenido:**
  4583. -
  4584. -.. code:: json
  4585. -
  4586. - {
  4587. - "error":"Ocurrio un problema inesperado en el servidor"
  4588. - }
  4589. -
  4590. -
  4591. -Observaciones
  4592. -`````````````
  4593. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  4594. -- El parámetro 'orden' depende de 'ordenarPor'
  4595. -- El parámetro 'pagina' muestra 15 oficinas por defecto
  4596. -
  4597. -----
  4598. -
  4599. -Crear una oficina
  4600. ------------------
  4601. -
  4602. -URL
  4603. -```
  4604. -::
  4605. -
  4606. - /oficinas
  4607. -
  4608. -Método
  4609. -``````
  4610. -``POST``
  4611. -
  4612. -Parámetros del body
  4613. -```````````````````
  4614. -**Ejemplo**
  4615. -
  4616. -.. code:: json
  4617. -
  4618. - {
  4619. - "nombre":"Dirección de Finanzas",
  4620. - "pais":"Bolivia",
  4621. - "latitud": "-16.85",
  4622. - "longitud": "-68.15",
  4623. - "principal": false
  4624. - }
  4625. -
  4626. -Respuesta correcta
  4627. -``````````````````
  4628. -
  4629. -**Código:** 201
  4630. -
  4631. -**Contenido:**
  4632. -
  4633. -.. code:: json
  4634. -
  4635. - {
  4636. - "_id": 35,
  4637. - "nombre": "Dirección de Finanzas",
  4638. - "pais": "Bolivia",
  4639. - "latitud": -16.85,
  4640. - "longitud": -68.15,
  4641. - "principal": false,
  4642. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  4643. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  4644. - }
  4645. -
  4646. -Respuesta de error
  4647. -``````````````````
  4648. -
  4649. -**Código:** 400
  4650. -
  4651. -**Contenido:**
  4652. -
  4653. -.. code:: json
  4654. -
  4655. - {
  4656. - "name": "SequelizeValidationError",
  4657. - "message": "Validation error: Ingrese Nombre a Oficina.",
  4658. - "errors": [
  4659. - {
  4660. - "message": "Ingrese Nombre a Oficina.",
  4661. - "type": "Validation error",
  4662. - "path": "nombre",
  4663. - "value": {},
  4664. - "__raw": {}
  4665. - }
  4666. - ]
  4667. - }
  4668. -
  4669. -----
  4670. -
  4671. -Mostrar una oficina
  4672. --------------------
  4673. -URL
  4674. -```
  4675. -::
  4676. -
  4677. - /oficinas/:id
  4678. -
  4679. -Método
  4680. -``````
  4681. -``GET``
  4682. -
  4683. -Parámetros de la URL
  4684. -````````````````````
  4685. -
  4686. -**Parámetro requerido:**
  4687. -
  4688. -============ ============== ================================================
  4689. -**Nombre** **Tipo** **Descripción**
  4690. -============ ============== ================================================
  4691. -`id` Integer Identificador único del registro en la entidad.
  4692. -============ ============== ================================================
  4693. -
  4694. -**Ejemplo**
  4695. -::
  4696. -
  4697. - id=35
  4698. -
  4699. -Respuesta correcta
  4700. -``````````````````
  4701. -
  4702. -**Código:** 200
  4703. -
  4704. -**Ejemplo**
  4705. -
  4706. -.. code:: json
  4707. -
  4708. - {
  4709. - "_id": 35,
  4710. - "nombre": "Dirección de Finanzas",
  4711. - "pais": "Bolivia",
  4712. - "latitud": -16.85,
  4713. - "longitud": -68.15,
  4714. - "principal": false,
  4715. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  4716. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  4717. - }
  4718. -
  4719. -Respuesta de error
  4720. -``````````````````
  4721. -
  4722. -**Código:** 404
  4723. -
  4724. -**Contenido:**
  4725. -
  4726. -.. code:: json
  4727. -
  4728. - {
  4729. - "message": "Entidad no encontrada"
  4730. - }
  4731. -
  4732. -----
  4733. -
  4734. -Editar una oficina
  4735. -------------------
  4736. -URL
  4737. -```
  4738. -::
  4739. -
  4740. - /oficinas/:id
  4741. -
  4742. -Método
  4743. -``````
  4744. -``PUT``
  4745. -
  4746. -Parámetros de la URL
  4747. -````````````````````
  4748. -
  4749. -**Parámetro requerido:**
  4750. -
  4751. -============ ============== ================================================
  4752. -**Nombre** **Tipo** **Descripción**
  4753. -============ ============== ================================================
  4754. -`id` Integer Identificador único del registro en la entidad.
  4755. -============ ============== ================================================
  4756. -
  4757. -**Ejemplo**
  4758. -::
  4759. -
  4760. - id=35
  4761. -
  4762. -Parámetros del body
  4763. -```````````````````
  4764. -
  4765. -**Ejemplo**
  4766. -
  4767. -.. code:: json
  4768. -
  4769. - {
  4770. - "nombre":"Dirección de Finanzas y Administración"
  4771. - }
  4772. -
  4773. -
  4774. -Respuesta correcta
  4775. -``````````````````
  4776. -
  4777. -**Código:** 200
  4778. -
  4779. -**Contenido:**
  4780. -
  4781. -.. code:: json
  4782. -
  4783. - {
  4784. - "_id": 35,
  4785. - "nombre": "Dirección de Finanzas y Administración",
  4786. - "pais": "Bolivia",
  4787. - "latitud": -16.85,
  4788. - "longitud": -68.15,
  4789. - "principal": false,
  4790. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  4791. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  4792. - }
  4793. -
  4794. -Respuesta de error
  4795. -``````````````````
  4796. -
  4797. -**Código:** 404
  4798. -
  4799. -**Contenido:**
  4800. -
  4801. -.. code:: json
  4802. -
  4803. - {
  4804. - "message": "Entidad no encontrada"
  4805. - }
  4806. -
  4807. -**Código:** 400
  4808. -
  4809. -**Contenido:**
  4810. -
  4811. -.. code:: json
  4812. -
  4813. - {
  4814. - "name": "SequelizeValidationError",
  4815. - "message": "Validation error: Ingrese Nombre a Oficina.",
  4816. - "errors": [
  4817. - {
  4818. - "message": "Ingrese Nombre a Oficina.",
  4819. - "type": "Validation error",
  4820. - "path": "nombre",
  4821. - "value": {},
  4822. - "__raw": {}
  4823. - }
  4824. - ]
  4825. - }
  4826. -
  4827. -----
  4828. -
  4829. -Eliminar una oficina
  4830. ---------------------
  4831. -URL
  4832. -```
  4833. -::
  4834. -
  4835. - /oficinas/:id
  4836. -
  4837. -Método
  4838. -``````
  4839. -``DELETE``
  4840. -
  4841. -Parámetros de la URL
  4842. -````````````````````
  4843. -
  4844. -**Parámetro requerido:**
  4845. -
  4846. -============ ============== ================================================
  4847. -**Nombre** **Tipo** **Descripción**
  4848. -============ ============== ================================================
  4849. -`id` Integer Identificador único del registro en la entidad.
  4850. -============ ============== ================================================
  4851. -
  4852. -**Ejemplo**
  4853. -::
  4854. -
  4855. - id=83
  4856. -
  4857. -Respuesta correcta
  4858. -``````````````````
  4859. -
  4860. -**Código:** 204
  4861. -
  4862. -Respuesta de error
  4863. -``````````````````
  4864. -
  4865. -**Código:** 404
  4866. -
  4867. -**Contenido:**
  4868. -
  4869. -.. code:: json
  4870. -
  4871. - {
  4872. - "message": "Entidad no encontrada"
  4873. - }
  4874. +Respuestas
  4875. +----------
  4876. +
  4877. ++------------------+----------------------------------------------------------------------------------------------+
  4878. +| **Código HTTP** | **Descripción** |
  4879. ++==================+==============================================================================================+
  4880. +| `200` | Ok |
  4881. ++------------------+----------------------------------------------------------------------------------------------+
  4882. +| `201` | Creado |
  4883. ++------------------+----------------------------------------------------------------------------------------------+
  4884. +| `400` | Parámetros incorrectos en la entrada |
  4885. ++------------------+----------------------------------------------------------------------------------------------+
  4886. +| `401` | Token de acceso expirado o invalido |
  4887. ++------------------+----------------------------------------------------------------------------------------------+
  4888. +| `404` | Recurso no encontrado |
  4889. ++------------------+----------------------------------------------------------------------------------------------+
  4890. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  4891. ++------------------+----------------------------------------------------------------------------------------------+
  4892. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  4893. ++------------------+----------------------------------------------------------------------------------------------+
  4894. +| `500` | Error interno del servidor |
  4895. ++------------------+----------------------------------------------------------------------------------------------+
  4896. diff --git a/docs/oficinaUnidad/oficinaUnidad.rst b/docs/oficinaUnidad/oficinaUnidad.rst
  4897. index f4a5fec..7a60443 100644
  4898. --- a/docs/oficinaUnidad/oficinaUnidad.rst
  4899. +++ b/docs/oficinaUnidad/oficinaUnidad.rst
  4900. @@ -1,554 +1,65 @@
  4901. -Relacion entre oficina y unidad
  4902. -===============================
  4903. -
  4904. -Mostrar todas las relaciones entre oficina y unidad
  4905. ----------------------------------------------------
  4906. -
  4907. -URL
  4908. -```
  4909. -::
  4910. -
  4911. - /oficinasUnidad
  4912. -
  4913. -Método
  4914. -``````
  4915. -``GET``
  4916. -
  4917. -Respuesta correcta
  4918. -``````````````````
  4919. -
  4920. -**Código:** 200
  4921. -
  4922. -**Contenido:**
  4923. -
  4924. -.. code:: json
  4925. -
  4926. - {
  4927. - "count": 2,
  4928. - "rows": [
  4929. - {
  4930. - "_id": 8,
  4931. - "principal": true,
  4932. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  4933. - "fecha_modificacion": "2016-05-30T13:41:29.210Z",
  4934. - "fk_oficina": 1,
  4935. - "fk_unidad_organizacional": 94
  4936. - },
  4937. - {
  4938. - "_id": 9,
  4939. - "principal": true,
  4940. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  4941. - "fecha_modificacion": "2016-05-30T13:43:59.979Z",
  4942. - "fk_oficina": 2,
  4943. - "fk_unidad_organizacional": 95
  4944. - }
  4945. - ]
  4946. - }
  4947. -
  4948. -Parámetros opcionales de la URL
  4949. -```````````````````````````````
  4950. -Tabla de parámetros
  4951. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  4952. -+-+-----------+------------------+---------------------------------------------------------------------+
  4953. -|**Nombre** |**Tipo** |**Descripción** |
  4954. -+=+===========+==================+=====================================================================+
  4955. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  4956. -+-+-----------+------------------+---------------------------------------------------------------------+
  4957. -|`pagina` | Integer |El número de página a mostrar. |
  4958. -+-+-----------+------------------+---------------------------------------------------------------------+
  4959. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  4960. -+-+-----------+------------------+---------------------------------------------------------------------+
  4961. -|`orden` | Boolean |TRUE para un orden descendente. |
  4962. -+-+-----------+------------------+---------------------------------------------------------------------+
  4963. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  4964. -+-+-----------+------------------+---------------------------------------------------------------------+
  4965. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  4966. -+-+-----------+------------------+---------------------------------------------------------------------+
  4967. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  4968. -+-+-----------+------------------+---------------------------------------------------------------------+
  4969. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  4970. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  4971. -| | |`buscar` definido anteriormente) |
  4972. -+-+-----------+------------------+---------------------------------------------------------------------+
  4973. -| |`entidad` | String |El nombre de la entidad. |
  4974. -+-+-----------+------------------+---------------------------------------------------------------------+
  4975. -
  4976. -Muestra una determinada cantidad de oficinas
  4977. -''''''''''''''''''''''''''''''''''''''''''''
  4978. -
  4979. -**URL**
  4980. -::
  4981. -
  4982. - /oficinasUnidad?elementos=valor
  4983. -
  4984. -**Parámetros usados**
  4985. -
  4986. -============ =====================
  4987. -**Nombre** **Valor enviado**
  4988. -============ =====================
  4989. -`elementos` 1
  4990. -============ =====================
  4991. -
  4992. -**Ejemplo:**
  4993. -
  4994. -::
  4995. -
  4996. - /oficinasUnidad?elementos=1
  4997. -
  4998. -**Respuesta:**
  4999. -
  5000. -.. code:: json
  5001. -
  5002. - {
  5003. - "count": 2,
  5004. - "rows": [
  5005. - {
  5006. - "_id": 8,
  5007. - "principal": true,
  5008. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5009. - "fecha_modificacion": "2016-05-30T13:41:29.210Z",
  5010. - "fk_oficina": 1,
  5011. - "fk_unidad_organizacional": 94
  5012. - },
  5013. - ]
  5014. - }
  5015. -
  5016. -Muestra las relaciones entre oficina y unidad en una determinada página
  5017. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  5018. -
  5019. -**URL**
  5020. -::
  5021. -
  5022. - /oficinasUnidad?pagina=valor
  5023. -
  5024. -**Parámetros usados**
  5025. -
  5026. -============ =====================
  5027. -**Nombre** **Valor enviado**
  5028. -============ =====================
  5029. -`pagina` 1
  5030. -============ =====================
  5031. -
  5032. -**Ejemplo:**
  5033. -::
  5034. -
  5035. - /oficinasUnidad?pagina=1
  5036. -
  5037. -**Respuesta:**
  5038. -
  5039. -.. code:: json
  5040. -
  5041. - {
  5042. - "count": 2,
  5043. - "rows": [
  5044. - {
  5045. - "_id": 8,
  5046. - "principal": true,
  5047. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5048. - "fecha_modificacion": "2016-05-30T13:41:29.210Z",
  5049. - "fk_oficina": 1,
  5050. - "fk_unidad_organizacional": 94
  5051. - },
  5052. - {
  5053. - "_id": 9,
  5054. - "principal": true,
  5055. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5056. - "fecha_modificacion": "2016-05-30T13:43:59.979Z",
  5057. - "fk_oficina": 2,
  5058. - "fk_unidad_organizacional": 95
  5059. - }
  5060. - ]
  5061. - }
  5062. -
  5063. -Ordena las relaciones entre oficina y unidad ascendentemente en base a un campo del modelo
  5064. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  5065. -
  5066. -**URL**
  5067. -::
  5068. -
  5069. - /oficinasUnidad?ordenarPor=valor
  5070. -
  5071. -**Parámetros usados**
  5072. -
  5073. -============ =====================
  5074. -**Nombre** **Valor enviado**
  5075. -============ =====================
  5076. -`ordenarPor` nombre
  5077. -============ =====================
  5078. -
  5079. -**Ejemplo**
  5080. -::
  5081. -
  5082. - /oficinasUnidad?ordenarPor=nombre
  5083. -
  5084. -**Respuesta:**
  5085. -
  5086. -.. code:: json
  5087. -
  5088. - {
  5089. - "count": 2,
  5090. - "rows": [
  5091. - {
  5092. - "_id": 8,
  5093. - "principal": true,
  5094. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5095. - "fecha_modificacion": "2016-05-30T13:41:29.210Z",
  5096. - "fk_oficina": 1,
  5097. - "fk_unidad_organizacional": 94
  5098. - },
  5099. - {
  5100. - "_id": 9,
  5101. - "principal": true,
  5102. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5103. - "fecha_modificacion": "2016-05-30T13:43:59.979Z",
  5104. - "fk_oficina": 2,
  5105. - "fk_unidad_organizacional": 95
  5106. - }
  5107. - ]
  5108. - }
  5109. -
  5110. -Ordena las relaciones entre oficina y unidad descendentemente en base a un campo del modelo
  5111. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  5112. -
  5113. -**URL**
  5114. -::
  5115. -
  5116. - /oficinasUnidad?ordenarPor=valor1&orden=true
  5117. -
  5118. -**Parámetros usados**
  5119. -
  5120. -============ =================
  5121. -**Nombre** **Valor enviado**
  5122. -============ =================
  5123. -`ordenarPor` nombre
  5124. -`orden` true
  5125. -============ =================
  5126. -
  5127. -**Ejemplo:**
  5128. -::
  5129. -
  5130. - /oficinasUnidad?ordenarPor=nombre&orden=true
  5131. -
  5132. -**Respuesta:**
  5133. -
  5134. -.. code:: json
  5135. -
  5136. - {
  5137. - "count": 2,
  5138. - "rows": [
  5139. - {
  5140. - "_id": 8,
  5141. - "principal": true,
  5142. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5143. - "fecha_modificacion": "2016-05-30T13:41:29.210Z",
  5144. - "fk_oficina": 1,
  5145. - "fk_unidad_organizacional": 94
  5146. - },
  5147. - {
  5148. - "_id": 9,
  5149. - "principal": true,
  5150. - "fecha_creacion": "2016-05-30T13:41:29.210Z",
  5151. - "fecha_modificacion": "2016-05-30T13:43:59.979Z",
  5152. - "fk_oficina": 2,
  5153. - "fk_unidad_organizacional": 95
  5154. - }
  5155. - ]
  5156. - }
  5157. -
  5158. -Respuesta de error
  5159. -``````````````````
  5160. -
  5161. -**Código:** 500
  5162. -
  5163. -**Contenido:**
  5164. -
  5165. -.. code:: json
  5166. -
  5167. - {
  5168. - "error":"Ocurrio un problema inesperado en el servidor"
  5169. - }
  5170. -
  5171. -
  5172. -Observaciones
  5173. -`````````````
  5174. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  5175. -- El parámetro 'orden' depende de 'ordenarPor'
  5176. -- El parámetro 'pagina' muestra 15 oficinas por defecto
  5177. -
  5178. -----
  5179. -
  5180. -Crear una relacion entre oficina y unidad
  5181. ------------------------------------------
  5182. -
  5183. -URL
  5184. -```
  5185. -::
  5186. -
  5187. - /oficinasUnidad
  5188. -
  5189. -Método
  5190. -``````
  5191. -``POST``
  5192. -
  5193. -Parámetros del body
  5194. -```````````````````
  5195. -**Ejemplo**
  5196. -
  5197. -.. code:: json
  5198. -
  5199. - {
  5200. - "nombre":"Dirección de Finanzas",
  5201. - "pais":"Bolivia",
  5202. - "latitud": "-16.85",
  5203. - "longitud": "-68.15",
  5204. - "principal": false
  5205. - }
  5206. -
  5207. -Respuesta correcta
  5208. -``````````````````
  5209. -
  5210. -**Código:** 201
  5211. -
  5212. -**Contenido:**
  5213. -
  5214. -.. code:: json
  5215. -
  5216. - {
  5217. - "_id": 35,
  5218. - "nombre": "Dirección de Finanzas",
  5219. - "pais": "Bolivia",
  5220. - "latitud": -16.85,
  5221. - "longitud": -68.15,
  5222. - "principal": false,
  5223. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  5224. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  5225. - }
  5226. -
  5227. -Respuesta de error
  5228. -``````````````````
  5229. -
  5230. -**Código:** 400
  5231. -
  5232. -**Contenido:**
  5233. -
  5234. -.. code:: json
  5235. -
  5236. - {
  5237. - "name": "SequelizeValidationError",
  5238. - "message": "Validation error: Ingrese Nombre a Oficina.",
  5239. - "errors": [
  5240. - {
  5241. - "message": "Ingrese Nombre a Oficina.",
  5242. - "type": "Validation error",
  5243. - "path": "nombre",
  5244. - "value": {},
  5245. - "__raw": {}
  5246. - }
  5247. - ]
  5248. - }
  5249. -
  5250. -----
  5251. -
  5252. -Mostrar una relacion entre oficina y unidad
  5253. --------------------------------------------
  5254. -URL
  5255. -```
  5256. -::
  5257. -
  5258. - /oficinasUnidad/:id
  5259. -
  5260. -Método
  5261. -``````
  5262. -``GET``
  5263. -
  5264. -Parámetros de la URL
  5265. -````````````````````
  5266. -
  5267. -**Parámetro requerido:**
  5268. -
  5269. -============ ============== ================================================
  5270. -**Nombre** **Tipo** **Descripción**
  5271. -============ ============== ================================================
  5272. -`id` Integer Identificador único del registro en la entidad.
  5273. -============ ============== ================================================
  5274. -
  5275. -**Ejemplo**
  5276. -::
  5277. -
  5278. - id=35
  5279. -
  5280. -Respuesta correcta
  5281. -``````````````````
  5282. -
  5283. -**Código:** 200
  5284. -
  5285. -**Ejemplo**
  5286. -
  5287. -.. code:: json
  5288. -
  5289. - {
  5290. - "_id": 35,
  5291. - "nombre": "Dirección de Finanzas",
  5292. - "pais": "Bolivia",
  5293. - "latitud": -16.85,
  5294. - "longitud": -68.15,
  5295. - "principal": false,
  5296. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  5297. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  5298. - }
  5299. -
  5300. -Respuesta de error
  5301. -``````````````````
  5302. -
  5303. -**Código:** 404
  5304. -
  5305. -**Contenido:**
  5306. -
  5307. -.. code:: json
  5308. -
  5309. - {
  5310. - "message": "Entidad no encontrada"
  5311. - }
  5312. -
  5313. -----
  5314. -
  5315. -Editar una relacion entre oficina y unidad
  5316. -------------------------------------------
  5317. -URL
  5318. -```
  5319. -::
  5320. -
  5321. - /oficinasUnidad/:id
  5322. -
  5323. -Método
  5324. -``````
  5325. -``PUT``
  5326. -
  5327. -Parámetros de la URL
  5328. -````````````````````
  5329. -
  5330. -**Parámetro requerido:**
  5331. -
  5332. -============ ============== ================================================
  5333. -**Nombre** **Tipo** **Descripción**
  5334. -============ ============== ================================================
  5335. -`id` Integer Identificador único del registro en la entidad.
  5336. -============ ============== ================================================
  5337. -
  5338. -**Ejemplo**
  5339. -::
  5340. -
  5341. - id=35
  5342. -
  5343. -Parámetros del body
  5344. -```````````````````
  5345. -
  5346. -**Ejemplo**
  5347. -
  5348. -.. code:: json
  5349. -
  5350. - {
  5351. - "nombre":"Dirección de Finanzas y Administración"
  5352. - }
  5353. -
  5354. -
  5355. -Respuesta correcta
  5356. -``````````````````
  5357. -
  5358. -**Código:** 200
  5359. -
  5360. -**Contenido:**
  5361. -
  5362. -.. code:: json
  5363. -
  5364. - {
  5365. - "_id": 35,
  5366. - "nombre": "Dirección de Finanzas y Administración",
  5367. - "pais": "Bolivia",
  5368. - "latitud": -16.85,
  5369. - "longitud": -68.15,
  5370. - "principal": false,
  5371. - "fecha_modificacion": "2016-05-30T13:10:47.884Z",
  5372. - "fecha_creacion": "2016-05-30T13:10:47.884Z"
  5373. - }
  5374. -
  5375. -Respuesta de error
  5376. -``````````````````
  5377. -
  5378. -**Código:** 404
  5379. -
  5380. -**Contenido:**
  5381. -
  5382. -.. code:: json
  5383. -
  5384. - {
  5385. - "message": "Entidad no encontrada"
  5386. - }
  5387. -
  5388. -**Código:** 400
  5389. -
  5390. -**Contenido:**
  5391. -
  5392. -.. code:: json
  5393. -
  5394. - {
  5395. - "name": "SequelizeValidationError",
  5396. - "message": "Validation error: Ingrese Nombre a Oficina.",
  5397. - "errors": [
  5398. - {
  5399. - "message": "Ingrese Nombre a Oficina.",
  5400. - "type": "Validation error",
  5401. - "path": "nombre",
  5402. - "value": {},
  5403. - "__raw": {}
  5404. - }
  5405. - ]
  5406. - }
  5407. -
  5408. -----
  5409. -
  5410. -Eliminar una relacion entre oficina y unidad
  5411. ---------------------------------------------
  5412. -URL
  5413. -```
  5414. -::
  5415. -
  5416. - /oficinasUnidad/:id
  5417. -
  5418. -Método
  5419. -``````
  5420. -``DELETE``
  5421. -
  5422. -Parámetros de la URL
  5423. -````````````````````
  5424. -
  5425. -**Parámetro requerido:**
  5426. -
  5427. -============ ============== ================================================
  5428. -**Nombre** **Tipo** **Descripción**
  5429. -============ ============== ================================================
  5430. -`id` Integer Identificador único del registro en la entidad.
  5431. -============ ============== ================================================
  5432. -
  5433. -**Ejemplo**
  5434. -::
  5435. -
  5436. - id=83
  5437. -
  5438. -Respuesta correcta
  5439. -``````````````````
  5440. -
  5441. -**Código:** 204
  5442. -
  5443. -Respuesta de error
  5444. -``````````````````
  5445. -
  5446. -**Código:** 404
  5447. -
  5448. -**Contenido:**
  5449. -
  5450. -.. code:: json
  5451. -
  5452. - {
  5453. - "message": "Entidad no encontrada"
  5454. - }
  5455. +Oficina Unidad
  5456. +====================
  5457. +
  5458. +Formato URL
  5459. +------------------------
  5460. ++-----------------+-------------------------+
  5461. +|**Método HTTP** |**Significado** |
  5462. ++=================+=========================+
  5463. +|`GET` | Obtiene un recurso |
  5464. ++-----------------+-------------------------+
  5465. +|`POST` | Crea un recurso |
  5466. ++-----------------+-------------------------+
  5467. +|`PUT` | Actualiza un recurso |
  5468. ++-----------------+-------------------------+
  5469. +|`DELETE` | Borra un recurso |
  5470. ++-----------------+-------------------------+
  5471. +
  5472. +Ejemplo
  5473. +''''''''''''
  5474. +
  5475. +**Contenido Body**
  5476. +
  5477. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  5478. +
  5479. +.. code:: json
  5480. +
  5481. + {
  5482. + "principal": false,
  5483. + "fecha_creacion": "2016-04-27T20:58:20.042Z",
  5484. + "fecha_modificacion": "2016-04-27T20:58:20.042Z",
  5485. + "fk_oficina": 3, // Oficina Geo Bolivia
  5486. + "fk_unidad_organizacional": 651 // Unidad de Innovación y Desarrollo
  5487. + }
  5488. +
  5489. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  5490. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  5491. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  5492. +| /oficinasUnidad | Obtiene el listado de todos las Oficinas-Unidad | Crea un registro de Oficinas-Unidad | | |
  5493. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  5494. +| /oficinasUnidad/:id | Obtiene la Oficinas-Unidad identificado como :id | | Actualiza registro :id de Oficinas-Unidad | Elimina registro :id de Oficinas-Unidad |
  5495. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  5496. +
  5497. +
  5498. +Respuestas
  5499. +----------
  5500. +
  5501. ++------------------+----------------------------------------------------------------------------------------------+
  5502. +| **Código HTTP** | **Descripción** |
  5503. ++==================+==============================================================================================+
  5504. +| `200` | Ok |
  5505. ++------------------+----------------------------------------------------------------------------------------------+
  5506. +| `201` | Creado |
  5507. ++------------------+----------------------------------------------------------------------------------------------+
  5508. +| `400` | Parámetros incorrectos en la entrada |
  5509. ++------------------+----------------------------------------------------------------------------------------------+
  5510. +| `401` | Token de acceso expirado o invalido |
  5511. ++------------------+----------------------------------------------------------------------------------------------+
  5512. +| `404` | Recurso no encontrado |
  5513. ++------------------+----------------------------------------------------------------------------------------------+
  5514. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  5515. ++------------------+----------------------------------------------------------------------------------------------+
  5516. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  5517. ++------------------+----------------------------------------------------------------------------------------------+
  5518. +| `500` | Error interno del servidor |
  5519. ++------------------+----------------------------------------------------------------------------------------------+
  5520. diff --git a/docs/mockups/mockups.rst b/docs/otros/guia_mockup.rst
  5521. similarity index 71%
  5522. rename from docs/mockups/mockups.rst
  5523. rename to docs/otros/guia_mockup.rst
  5524. index 7fdd8ae..80f3195 100644
  5525. --- a/docs/mockups/mockups.rst
  5526. +++ b/docs/otros/guia_mockup.rst
  5527. @@ -1,33 +1,33 @@
  5528. -Mockups Proyecto
  5529. -================
  5530. +Mockup con PENCIL
  5531. +=================
  5532.  
  5533. Introducción
  5534. -------------
  5535. +---------------
  5536.  
  5537. El mockup del Proyecto es un prototipo con el que proporciona al menos una parte de la funcionalidad del sistema y permite pruebas del diseño. Este diseño permitirá comentarios por parte de los usuarios.
  5538.  
  5539. Software de diseño mockup - Pencil
  5540. -----------------------------------
  5541. +---------------------------------------------
  5542.  
  5543. -Pencil es una bonita herramienta GUI de prototipos de código abierto.
  5544. +Pencil es una buena herramienta GUI de prototipos de código abierto.
  5545.  
  5546. Instalación Pencil en Debian Jessie
  5547. ------------------------------------
  5548. +---------------------------------------------
  5549.  
  5550. -- Descarga la ultima versión.
  5551. +Descarga la ultima versión.
  5552.  
  5553. .. code:: sh
  5554.  
  5555. $ wget https://evoluspencil.googlecode.com/files/evoluspencil_2.0.5_all.deb
  5556.  
  5557. -- Descomprimir el paquete debian
  5558. +Descomprimir el paquete debian
  5559.  
  5560. .. code:: sh
  5561.  
  5562. $ dpkg-deb -x evoluspencil_2.0.5_all.deb dir_tmp
  5563. $ dpkg-deb --control evoluspencil_2.0.5_all.deb dir_tmp/DEBIAN
  5564.  
  5565. -- Editar archivo dir\_tmp/DEBIAN/control
  5566. +Editar archivo dir\_tmp/DEBIAN/control
  5567.  
  5568. .. code:: sh
  5569.  
  5570. @@ -43,13 +43,13 @@ Instalación Pencil en Debian Jessie
  5571. Description: Evolus Pencil
  5572. Pencil is an open source GUI prototyping and sketching tools released under GPL.
  5573.  
  5574. -- Vuelva a empaquetar el paquete debian
  5575. +Vuelva a empaquetar el paquete debian
  5576.  
  5577. .. code:: sh
  5578.  
  5579. $ dpkg -b dir_tmp evoluspencil_2.0.5_all.deb
  5580.  
  5581. -- Instalar el paquete
  5582. +Instalar el paquete
  5583.  
  5584. .. code:: sh
  5585.  
  5586. diff --git a/docs/otros/guia_test.rst b/docs/otros/guia_test.rst
  5587. new file mode 100644
  5588. index 0000000..3211103
  5589. --- /dev/null
  5590. +++ b/docs/otros/guia_test.rst
  5591. @@ -0,0 +1,175 @@
  5592. +Guía de Test
  5593. +===============
  5594. +
  5595. +`Mocha`_ nos ayuda a tener un marco de trabajo para realizar nuestras pruebas(test) de manera ordenada.
  5596. +
  5597. +Dentro del proyecto y en una terminal de comandos escribir **npm test** para ejecutar los test.
  5598. +
  5599. +Cada uno de las entidades cuentan con su modulo de test **[entidad].controller.js**.
  5600. +
  5601. +Los test de cada proceso estan en **[entidad].integration.js**.
  5602. +
  5603. +Lo primero que debemos realizar es verificar las rutas de cada entidad, y estas las encontramos en **index.spec.js** de cada entidad.
  5604. +
  5605. +
  5606. +Aplicación
  5607. +---------------
  5608. +Creación de una `Persona`.
  5609. +
  5610. +Extraido de `/api/persona/index.spec.js`
  5611. +
  5612. +.. code:: javascript
  5613. +
  5614. + describe('POST /api/personas', function () {
  5615. +
  5616. + it('Debe apuntar a la ruta persona.controller.create', function () {
  5617. + expect(routerStub.post
  5618. + .withArgs('/', 'autenticacionService.tieneRol.ADMINISTRATOR', 'personaCtrl.create')
  5619. + ).to.have.been.calledOnce;
  5620. + });
  5621. +
  5622. + });
  5623. +
  5624. +Ahora realizaremos el test, que nos permitirá verificar la creación de la Persona:
  5625. +
  5626. +Extraido de `/api/persona/persona.integration.js`
  5627. +
  5628. +.. code:: javascript
  5629. +
  5630. + describe('POST /api/personas', function () {
  5631. + it('Debe crear una nueva persona', function (done) {
  5632. + request(app)
  5633. + .post('/api/personas')
  5634. + .set('authorization', 'Bearer ' + token)
  5635. + .send({nombres: 'Juan Perez', apellidos: 'Lopez Gomez', ci: '123123'})
  5636. + .expect(201)
  5637. + .expect('Content-Type', /json/)
  5638. + .end((err, res)=> {
  5639. + nuevoPostulante = res.body;
  5640. + expect(res.body.nombres).to.equal("Juan Perez");
  5641. + expect(res.body.apellidos).to.equal("Lopez Gomez");
  5642. + expect(res.body.ci).to.equal("123123");
  5643. + done();
  5644. + })
  5645. + })
  5646. + });
  5647. +
  5648. +El **describe** puede contener otros describe o puede contener las pruebas en sí que encuentran dentro del **it**.
  5649. +
  5650. +Realizamos **request** una solicitud del método **post** de nuestra *api* en **/api/personas**.
  5651. +
  5652. +Realizamos la autenticación mediante **set** de la siguiente manera (**'authorization', 'Bearer ' + token**).
  5653. +
  5654. +Con **send** enviamos nuestro *json* con los datos a ser creados.
  5655. +
  5656. +El **expect** realiza una comparación de elementos y registra los elementos que no cumplan con dicha comparación.
  5657. +
  5658. +En **res.body** tenemos el resultado de la operacion con los datos proporcionados por la **/api/personas**.
  5659. +
  5660. +A continuación le mostraremos algunos ejemplos de pruebas (test) que se pueden realizar para **persona**.
  5661. +
  5662. +
  5663. +Debe obtener un objeto con la cantidad de los personas y un array con todos los personas
  5664. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5665. +
  5666. +.. code:: javascript
  5667. +
  5668. + describe('GET /api/personas', function () {
  5669. + it('Debe obtener un objeto con la cantidad de los personas y un array con todos los personas', function (done) {
  5670. + request(app)
  5671. + .get('/api/personas')
  5672. + .set('authorization', 'Bearer ' + token)
  5673. + .expect(200)
  5674. + .expect('Content-Type', /json/)
  5675. + .end((err, res)=> {
  5676. + expect(res.body.count).to.equal(0);
  5677. + expect(res.body.rows).to.be.instanceOf(Array);
  5678. + done();
  5679. + })
  5680. + })
  5681. + });
  5682. +
  5683. +Debe obtener un postulante por el id
  5684. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5685. +
  5686. +.. code:: javascript
  5687. +
  5688. + describe('GET /api/personas/:id', function () {
  5689. + it('Debe obtener una persona por el id', function (done) {
  5690. + request(app)
  5691. + .get('/api/personas/' + nuevoPostulante._id)
  5692. + .set('authorization', 'Bearer ' + token)
  5693. + .expect(200)
  5694. + .expect('Content-Type', /json/)
  5695. + .end((err, res)=> {
  5696. + expect(res.body.nombres).to.equal(nuevoPostulante.nombres);
  5697. + expect(res.body.apellidos).to.equal(nuevoPostulante.apellidos);
  5698. + expect(res.body.ci).to.equal(nuevoPostulante.ci);
  5699. + done();
  5700. + })
  5701. + })
  5702. + });
  5703. +
  5704. +Debe actualizar el dato de una persona
  5705. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5706. +
  5707. +.. code:: javascript
  5708. +
  5709. + describe('PUT /api/personas/:id', function () {
  5710. + it('Debe actualizar una persona por el id ', function (done) {
  5711. + nuevoPostulante.nombres = "Ana";
  5712. + nuevoPostulante.apellidos = "Lopez Perez";
  5713. + nuevoPostulante.ci = "123456";
  5714. + request(app)
  5715. + .put('/api/personas/' + nuevoPostulante._id)
  5716. + .set('authorization', 'Bearer ' + token)
  5717. + .send({nombres: nuevoPostulante.nombres, apellidos: nuevoPostulante.apellidos, ci: nuevoPostulante.ci})
  5718. + .expect(200)
  5719. + .expect('Content-Type', /json/)
  5720. + .end((err, res)=> {
  5721. + expect(res.body.nombres).to.equal(nuevoPostulante.nombres);
  5722. + expect(res.body.apellidos).to.equal(nuevoPostulante.apellidos);
  5723. + expect(res.body.ci).to.equal(nuevoPostulante.ci);
  5724. + done();
  5725. + })
  5726. + })
  5727. + });
  5728. +
  5729. +Debe eliminar y verificar la eliminación de un registro de persona
  5730. +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  5731. +
  5732. +.. code:: javascript
  5733. +
  5734. + describe('DELETE /api/personas/:id', function () {
  5735. +
  5736. + it('Debe responder con 204 en la eliminación', function (done) {
  5737. + request(app)
  5738. + .delete('/api/personas/' + nuevoPostulante._id)
  5739. + .set('authorization', 'Bearer ' + token)
  5740. + .expect(204)
  5741. + .end((err, res) => {
  5742. + if (err) {
  5743. + return done(err);
  5744. + }
  5745. + done();
  5746. + });
  5747. + });
  5748. +
  5749. + it('Debe responder con 404 si la persona no existe', function (done) {
  5750. + request(app)
  5751. + .delete('/api/personas/' + nuevoPostulante._id)
  5752. + .set('authorization', 'Bearer ' + token)
  5753. + .expect(404)
  5754. + .end((err, res) => {
  5755. + if (err) {
  5756. + return done(err);
  5757. + }
  5758. + done();
  5759. + });
  5760. + });
  5761. +
  5762. + });
  5763. +
  5764. +
  5765. +
  5766. +.. _Mocha: https://mochajs.org/
  5767. diff --git a/docs/otros/licencia.rst b/docs/otros/licencia.rst
  5768. new file mode 100644
  5769. index 0000000..32f6677
  5770. --- /dev/null
  5771. +++ b/docs/otros/licencia.rst
  5772. @@ -0,0 +1,236 @@
  5773. +LICENCIA PÚBLICA GENERAL
  5774. +==============================================================================
  5775. +
  5776. +*Agencia para el Desarrollo de la Sociedad de la Información en Bolivia.*
  5777. +
  5778. +**LICENCIA PÚBLICA GENERAL**
  5779. +
  5780. +*de Consideraciones y Registro de Software Libre en Bolivia (LPG-Bolivia)*
  5781. +
  5782. +*Versión 1, 13 de mayo de 2014.*
  5783. +
  5784. +Introducción
  5785. +------------------------------
  5786. +
  5787. +Esta licencia está basada en la Licencia Pública General GNU (GNU GPL) de la Fundación para el Software Libre (www.fsf.org), la cual ha sido adaptada por la Agencia para el Desarrollo de la Sociedad de la Información en Bolivia (ADSIB) a la normativa legal vigente en Bolivia, enmarcada en la Ley General de Telecomunicaciones, Tecnologías de Información y Comunicación, Ley No. 164 de 8 de agosto de 2011 y el Reglamento para el Desarrollo de Tecnologías de Información y Comunicación aprobado por el Decreto Supremo No. 1793 de 13 de noviembre de 2013.
  5788. +
  5789. +
  5790. +Ésta no constituye una traducción oficial de la GNU GPL al español. No ha sido publicada por la Fundación para el Software Libre, y no establece legalmente las condiciones de distribución para el software que usa la GNU GPL –estas condiciones se establecen solamente por el texto original de la GNU GPL de la Fundación para el Software Libre (www.fsf.org).
  5791. +
  5792. +Esta licencia se aplica conforme a la legislación vigente y en orden de prelación normativa dando prioridad a lo normativa superior y sin vulnerar cualquier derecho consagrado por la Constitución y las Leyes del Estado Plurinacional de Bolivia.
  5793. +
  5794. +Esta licencia se basa en la traducción elaborada por Gonzalo Abella, Javier Aguirre, Héctor J. Macho Borja Menéndez, Javier Moset, Ángel Torrado.
  5795. +
  5796. +Preámbulo
  5797. +
  5798. +La Licencia Pública General Bolivia (LPG - Bolivia) es una licencia libre para software y otro tipo de obras.
  5799. +
  5800. +Las licencias para la mayoría del software y otras obras de carácter práctico están diseñadas para privarle de la libertad de compartir y modificar las obras. Por el contrario, esta Licencia Pública General pretende garantizar su libertad de compartir y modificar todas las versiones de un programa –para cerciorar que permanece como software libre para todos sus usuarios.
  5801. +
  5802. +Cuando hablamos de software libre, nos referimos a libertad de acción, no de precio. La LPG - Bolivia está diseñada para garantizar la libertad de distribuir copias de software libre (y cobrar por ello si quiere), de recibir el código fuente o poder conseguirlo si así lo desea, de modificar el software o usar parte del mismo en nuevos programas libres, y a saber que puede hacer estas cosas.
  5803. +
  5804. +Para proteger sus derechos, necesitamos evitar que otros le nieguen esos derechos o le pidan renunciar a ellos. Por lo tanto, usted tiene ciertas responsabilidades cuando distribuye copias del software, o si lo modifica: responsabilidades que persiguen respetar la libertad de otros.
  5805. +
  5806. +Si distribuye copias de un programa, bien sea gratis o por una tasa, debe transferirles a los que lo reciban las mismas libertades que usted recibió. Debe asegurarse que ellos, también, reciben o pueden obtener el código fuente. Y debe mostrarles estos términos para que ellos puedan conocer sus derechos.
  5807. +
  5808. +Los desarrolladores que usan la LPG-Bolivia protegen tus derechos con dos pasos: (1) haciendo valer el derecho de propiedad intelectual en el software y (2) le ofrecen esta Licencia que le da el permiso legal para copiarlo, distribuirlo y/o modificarlo.
  5809. +
  5810. +Para la protección de autores y desarrolladores, la LPG-Bolivia explica claramente que no hay garantía para este software libre. Por el bien de usuarios como de autores o titulares, la LPG-Bolivia establece que las versiones modificadas sean identificadas como tales, de forma que sus problemas no puedan ser atribuidos de forma errónea a autores de versiones previas.
  5811. +
  5812. +Algunos dispositivos están diseñados para denegar a los usuarios el acceso a instalar o ejecutar versiones modificadas del software en su interior, a pesar de que el fabricante puede hacerlo. Esto es fundamentalmente incompatible con el objetivo de proteger la libertad de los usuarios de modificar el software. Este tipo de abuso sistemático ocurre en el ámbito de los productos de uso personal, que es precisamente donde es más inaceptable. Por consiguiente, hemos diseñado esta versión de la LPG-Bolivia para prohibir estas prácticas en esos productos.
  5813. +
  5814. +Finalmente, todo programa está constantemente amenazado por las patentes de software. El Estado buscará los medios mas idóneos para evitar el especial peligro que suponen las patentes, que aplicadas a un programa libre puedan hacerlo propietario en la práctica. Para prevenir eso, la LPG-Bolivia establece que las patentes no pueden usarse para convertir un programa en no-libre.
  5815. +
  5816. +Los términos exactos y las condiciones para la copia, distribución y modificación se exponen a continuación.
  5817. +
  5818. +Términos y Condiciones
  5819. +------------------------------
  5820. +
  5821. +0. Definiciones
  5822. +
  5823. +“Licencia” se refiere a la Licencia Pública General Bolivia (LPG-Bolivia) "Copyright", “Derechos de Autor (“Copyright”)” incluye a las leyes similares a la de derechos de autor (“copyright”) que se apliquen a otro tipo de obras.
  5824. +
  5825. +“El Programa” se refiere a cualquier obra con derechos de autor bajo esta Licencia. Cada “licenciatario” o “destinatario” es tratado como “usted”. Los “licenciatarios”, y los “destinatarios” pueden ser individuos u organizaciones.
  5826. +
  5827. +“Modificar” una obra quiere decir copiar o adaptar parte o la totalidad de la obra de una forma que se requieran permisos de derechos de autor (“copyright”), distintos de los de hacer una copia exacta. La obra resultante es llamada “versión modificada” de la obra previa o una obra “basada en” la obra previa.
  5828. +
  5829. +“Obra amparada” significa o el Programa sin modificar o una obra basada en el Programa.
  5830. +
  5831. +"Difundir" una obra significa hacer cualquier cosa con él que, sin permiso, le haga directa o indirectamente responsable de infringir leyes de derechos de autor (“copyright”), excepto la ejecución en un ordenador o la modificación de una copia privada. La difusión incluye la copia, distribución (con o sin modificaciones) y publicación.
  5832. +
  5833. +"Transmitir" una obra quiere decir cualquier tipo de difusión que permita a otras partes hacer o recibir copias. La mera interacción con un usuario a través de una red informática, sin transferir una copia, no es transmitir.
  5834. +
  5835. +Una interfaz interactiva de usuario muestra “Avisos Legales Apropiados” en la medida que incluye una característica visible, práctica y destacada que (1) muestra un aviso apropiado de derechos de autor (“copyright”), y (2) informa al usuario de que no hay garantía para la obra (excepto las garantías proporcionadas), que los licenciatarios deben transmitir la obra bajo esta Licencia, y cómo ver una copia de esta Licencia. Si la interfaz presenta una lista de comandos de usuario u opciones, como un menú, un elemento destacado en la lista satisface este criterio.
  5836. +
  5837. +1. Código Fuente
  5838. +
  5839. +El "código fuente" de una obra es el formato preferido de la misma para realizar modificaciones sobre ella. "Código objeto" se refiere a cualquier formato de la obra que no sea código fuente.
  5840. +
  5841. +Una "Interfaz Estándar" se refiere a una interfaz que sea un estándar oficial definido por una institución de estándares reconocida, o bien, en el caso de interfaces específicas para un determinado lenguaje de programación, una cuyo uso esté generalizado entre los desarrolladores que trabajan con ese lenguaje.
  5842. +
  5843. +Las “Bibliotecas del Sistema” de una obra ejecutable incluyen cualquier cosa, diferente de la obra como un todo, que (a) está incluida en la forma normal de empaquetado de un Componente Importante, pero que no forme parte de ese Componente Importante, y (b) sirve solo para habilitar el uso de la obra con ese Componente Importante, o para implementar una Interfaz Estándar para la cual una implementación está disponible para el público en forma de código fuente. Un “Componente Importante”, en este contexto, significa un componente importante esencial (kernel, sistema de ventanas, etcétera) del sistema operativo en concreto (si hubiese) en el cual el ejecutable funciona o un compilador utilizado para producir la obra, o un intérprete de código objeto utilizado para hacerla funcionar.
  5844. +
  5845. +La “Fuente Correspondiente” de una obra en forma de código objeto significa todo el código fuente necesario para generar, instalar, y (para una obra ejecutable) hacer funcionar el código objeto y modificar la obra, incluyendo los scripts o guiones o archivos de órdenes para controlar dichas actividades. Sin embargo, ello no incluye la obra de las Bibliotecas del Sistema o herramientas de propósito general o programas de libre disponibilidad general, los cuales son usados sin modificaciones para la realización de dichas actividades, pero que no son parte de la obra. Por ejemplo, la Fuente Correspondiente incluye ficheros de definición de interfaces asociados a los ficheros fuente para la obra, y el código fuente para bibliotecas compartidas y subprogramas enlazados dinámicamente que la obra requiere específicamente por diseño, tales como la comunicación de datos intrínseca o flujo de control entre aquellos subprogramas y otras partes de la obra.
  5846. +
  5847. +La Fuente Correspondiente no incluye necesariamente aquello que los usuarios pueden regenerar automáticamente a partir de otras partes de la Fuente Correspondiente.
  5848. +
  5849. +La Fuente Correspondiente de una obra en forma de código fuente es la obra en sí.
  5850. +
  5851. +2. Permisos Básicos
  5852. +
  5853. +Todos los derechos concedidos bajo esta Licencia se conceden durante la duración de los derechos de autor (“copyright”) del Programa, y son irrevocables siempre que se cumplan las condiciones establecidas. Esta Licencia afirma explícitamente su permiso ilimitado para ejecutar el Programa sin modificar. El resultado de la ejecución de una obra amparada está cubierta por esta Licencia solo si el mismo, dado su contenido, constituye una obra amparada. Esta Licencia reconoce sus derechos de uso razonable u otro equivalente, según lo establecido por la ley de derechos de autor (“copyright”).
  5854. +
  5855. +Usted podrá realizar, ejecutar y difundir obras amparadas que usted no transmita sin condición alguna, siempre y cuando la Licencia vigente no establezca otra cosa. Podrá transmitir obras amparadas a terceros con el único propósito de que ellos hagan modificaciones exclusivamente para usted, o proporcionarle ayuda para ejecutar estas obras, siempre y cuando cumpla con los términos de esta Licencia en la transmisión de todo el material del cual usted no controle los derechos de autor (“copyright”). Aquellos que realicen o ejecuten las obras amparadas para usted, deben hacerlo exclusivamente en su nombre, bajo su dirección y control, en términos que prohiban realizar ninguna copia de su materia registrado bajo derechos de autor (“copyright”) fuera de la relación con usted.
  5856. +
  5857. +La transmisión bajo otras circunstancias se permite únicamente bajo las condiciones establecidas más abajo. No está permitido sublicenciar; la claúsula 10 lo hace innecesario.
  5858. +
  5859. +3. Protección de Derechos Legales de los Usuarios Frente a Leyes Anti-Evación.
  5860. +
  5861. +Ninguna obra amparada debe considerarse parte de una medida tecnológica efectiva, a tenor de lo establecido en cualquier ley aplicable que cumpla las obligaciones establecidas en el artículo 11 del tratado de derechos de autor (“copyright”) de WIPO adoptado el 20 de diciembre de 1996, por el hoy Estado Plurinacional de Bolivia o leyes similares que prohíban o restrinjan la evasión de tales medidas.
  5862. +
  5863. +Cuando transmita una obra amparada, renuncia a cualquier poder legal para prohibir la evasión de medidas tecnológicas, mientras tales evasiones se realicen en ejercicio de derechos amparados por esta Licencia respecto a la obra amparada; además, usted renuncia a cualquier intención de limitar el uso o modificación de la obra con el objetivo de imponer, en contra de los usuarios de la obra, sus derechos legales o los de terceros para prohibir la evasión de medidas tecnológicas.
  5864. +
  5865. +4. Transmisión de Copias Literales
  5866. +
  5867. +Usted podrá transmitir copias literales del código fuente del Programa tal cual lo ha recibido, por cualquier medio, siempre que publique visible y apropiadamente en cada copia el correspondiente aviso de derechos de autor (“copyright”); mantenga intactos todos los avisos que establezcan que esta Licencia y cualquier cláusula no-permisiva añadida acorde con la cláusula 7 aplicables al código; mantenga intactos todos los avisos de ausencia de garantía; y proporcione a todos los destinatarios una copia de esta Licencia junto con el Programa.
  5868. +
  5869. +Usted podrá cobrar cualquier importe o no cobrar nada por cada copia que transmita y podrá ofrecer soporte o protección de garantía mediante un pago.
  5870. +
  5871. +5. Transmisión de Versiones Modificadas del Código
  5872. +
  5873. +Usted puede transmitir una obra basada en el Programa, o las modificaciones para generarla a partir del Programa, en la forma de código fuente bajo los términos de la sección 4, siempre que cumpla además todas las condiciones siguientes:
  5874. +
  5875. +a) La obra debe incluir avisos destacados indicando que usted la ha modificado y dando una fecha pertinente.
  5876. +
  5877. +b) La obra debe incluir avisos destacados indicando que está liberada o publicada bajo esta Licencia y cualquier otra condición añadida bajo la sección 7. Este requerimiento modifica los requerimientos de la sección 4 de “mantener intactos todos los avisos”.
  5878. +
  5879. +c) Usted debe licenciar la obra entera, como un todo, bajo esta Licencia para cualquier persona que esté en posesión de una copia. Esta Licencia se aplicará por consiguiente junto con cualquier término adicional aplicable bajo la sección 7, a la totalidad de la obra y a todos sus componentes, independientemente de como estén empaquetados. Esta Licencia no autoriza a licenciar la obra de otra forma, pero no invalida esos permisos si usted los ha recibido de forma separada.
  5880. +
  5881. +d) Si la obra tiene interfaces de usuario interactivas, cada una debe mostrar los Avisos Legales Apropiados; sin embargo, si el Programa tiene interfaces interactivas que no muestran los Avisos Legales Apropiados, tampoco es necesario que su obra lo haga.
  5882. +
  5883. +Una recopilación de una obra amparada con otras obras separadas e independientes, que no son por su naturaleza extensiones de la obra amparada, y que no se combinan con ella con el fin de formar un programa más grande, en o sobre un volumen de un medio de almacenamiento o distribución, es llamado un “agregado” si la recopilación y sus resultantes derechos de autor (“copyright”) no son usados para limitar el acceso o los derechos legales de los usuarios de la recopilación más allá de lo que las obras individuales permitan. La inclusión de una obra amparada en un agregado no provoca que esta Licencia se aplique a los otros componentes del agregado.
  5884. +
  5885. +6. Transmisión de Código No-Fuente
  5886. +
  5887. +Usted podrá transmitir el código objeto de una obra amparada en virtud de los términos de las cláusulas 4 y 5, siempre que también transmita las Fuentes Correspondientes en código legible por máquina, de acuerdo con los términos establecidos en esta Licencia, de alguna de las siguientes maneras:
  5888. +
  5889. +a) Transmitir el código objeto en, o embebido en, un producto físico (incluyendo medios de distribución físicos), acompañado de las Fuentes Correspondientes en un medio físico duradero y que sea utilizado habitualmente para el intercambio de software.
  5890. +
  5891. +b) Transmitir el código objeto en, o embebido en, un producto físico (incluyendo medios de distribución físicos), acompañado de una oferta por escrito, válido durante al menos tres años y válido mientras usted ofrezca recambios o soporte para ese modelo de producto, de dar a cualquiera que posea el código objeto bien (1) una copia de las Fuentes Correspondientes a todo el software del producto que esté cubierto por esta Licencia, en un medio físico duradero habitual para el intercambio de software, a un precio razonable, directamente relacionado al costo de efectuar la transmisión física de la Fuente Correspondiente, o (2) acceso para copiar la Fuente Correspondiente de un servidor de red sin costo alguno.
  5892. +
  5893. +c) Transmitir copias individuales del código objeto junto con una copia del ofrecimiento escrito de proveer la Fuente Correspondiente. Esta alternativa sólo está permitida ocasionalmente y sin fines comerciales, y solamente si usted recibió el código objeto junto con una oferta parecida, de acuerdo con la subcláusula 6b.
  5894. +
  5895. +d) Transmitir el código objeto ofreciendo acceso desde un lugar determinado (gratuitamente o mediante pago) y ofrecer acceso equivalente a la Fuente Correspondiente de la misma manera en el mismo lugar sin cargo adicional. No es necesario exigir a los destinatarios que copien la Fuente Correspondiente junto con el código objeto. Si el lugar para copiar el código objeto es un servidor de red, la Fuente Correspondiente puede estar en un servidor diferente (gestionado por usted o un tercero) que ofrezca facilidades de copia equivalentes, siempre que mantenga instrucciones claras junto al código objeto especificando dónde encontrar la Fuente Correspondiente. Independientemente de qué servidor albergue la Fuente Correspondiente, usted seguirá estando obligado a asegurar que está disponible durante el tiempo que sea necesario para satisfacer estos requisitos.
  5896. +
  5897. +e) Transmitir el código mediante transferencias de red entre pares o usuarios (peer-to-peer), siempre que informe a los otros pares o usuarios dónde se ofrece el código objeto y la Fuente Correspondiente de la obra al público general de forma gratuita bajo la subsección 6d.
  5898. +
  5899. +Una porción separable del código objeto, cuyo código fuente está excluido de la Fuente Correspondiente como una Biblioteca del Sistema, no necesita ser incluida en la transmisión del código objeto de la obra.
  5900. +
  5901. +Un “Producto de Usuario” es o (1) un “producto de consumo”, lo que significa cualquier propiedad tangible personal que es usada habitualmente con fines personales, familiares o domésticos, o (2) cualquier cosa diseñada o vendida para ser incorporada en una vivienda. Al determinar si un producto es un producto de consumo, los casos dudosos serán resueltos en favor de la cobertura. Para un producto concreto recibido por un usuario concreto, “uso habitual” se refiere a un uso típico o común de esa clase de producto, sin tener en cuenta la situación del usuario concreto o la forma en la que el usuario concreto realmente use, o espera o se espera que use, el producto. Un producto es un producto de consumo independientemente de si el producto tiene usos esencialmente comerciales, industriales o distintos del consumo, a menos que dichos usos constituyan el único modo de uso significativo del producto.
  5902. +
  5903. +Las "Instrucciones de Instalación" para un Producto de Usuario se refieren a cualquier método, procedimiento, clave de autorización u otro tipo de información necesaria para instalar y ejecutar una versión modificada de una obra amparada en ese Producto de Usuario, a partir de una versión modificada de su Fuente Correspondiente. Las instrucciones deben ser suficientes para asegurar que el funcionamiento continuo del código objeto modificado no es evitado, condicionado o interferido por el hecho de haber sufrido tal modificación.
  5904. +
  5905. +Si transmite el código objeto de una obra en o con un Producto de Usuario o específicamente para ser usado en el mismo, y la transmisión forma parte de una transacción donde los derechos de posesión y uso del Producto de Usuario se transfieren al destinatario a perpetuidad o por un periodo establecido (independientemente de las características de la transacción), la Fuente Correspondiente transmitida bajo esta sección debe estar acompañada de las Instrucciones de Instalación. Pero este requisito no se aplica si ni usted ni ningún tercero tiene la capacidad de instalar código objeto modificado en el Producto de Usuario.
  5906. +
  5907. +El requisito de proveer de las Instrucciones de Instalación no incluye la necesidad de continuar proporcionando asistencia, garantía o actualizaciones para una obra que ha sido modificada o instalada por el destinatario, o para el Producto de Usuario en el cual ha sido modificada o instalada. El acceso a una red puede ser denegado cuando la modificación en sí afecta materialmente y adversamente el funcionamiento de la red o viola las reglas y protocolos de comunicación de la red.
  5908. +
  5909. +Las Fuentes Correspondientes transmitidas y las Instrucciones de Instalación proporcionadas de acuerdo con esta sección deben figurar en un formato documentado públicamente (y con una implementación disponible para el público en forma de código fuente), y no deben necesitar contraseñas o claves de acceso especiales para la extracción, lectura o copia.
  5910. +
  5911. +7. Condiciones adicionales
  5912. +
  5913. +Los “Permisos adicionales” son condiciones que complementan los términos de esta Licencia haciendo excepciones de una o más de una de sus condiciones. Los permisos adicionales que son aplicables al Programa entero deberán ser tratados como si estuvieran incluidos en esta Licencia, hasta los límites de validez impuestos por las leyes aplicables. Si los permisos adicionales sólo son aplicables a parte del Programa, esa parte debe ser usada por separado bajo esos permisos, pero el Programa completo queda bajo la autoridad de esta Licencia sin considerar los permisos adicionales.
  5914. +
  5915. +Cuando transmita una copia de una obra amparada, puede opcionalmente quitar cualesquiera permisos adicionales de esa copia, o de cualquier parte de ella. (Los permisos adicionales pueden ser escritos para requerir su propia eliminación bajo ciertos casos cuando se modifica la obra.) Puede incorporar permisos adicionales a material añadido por usted a una obra amparada, sobre el cual usted tiene o puede establecer los permisos de derechos de autor (“copyright”) correspondientes.
  5916. +
  5917. +Sin contravenir cualquier otra disposición de esta Licencia, para el material que añada a una obra cubierta por la misma, usted puede (si está autorizado por los titulares de los derechos de autor (“copyright”) del material) complementar los términos de esta Licencia en los siguientes términos:
  5918. +
  5919. +a) Declarando la ausencia de garantía o limitación de responsabilidad en forma diferente a la de los términos establecidos en las cláusulas 14 y 15 de esta Licencia; u
  5920. +
  5921. +b) Requiriendo la obligación de mantener determinados avisos legales razonables o atribuciones de autoría en el material o en los Avisos Legales Apropiados mostrados por las obras que lo contengan.
  5922. +
  5923. +c) Prohibir la tergiversación del origen del material o requerir que las versiones modificadas del material se señalen de manera razonable como diferentes de la versión original; o
  5924. +
  5925. +d) Limitar la utilización de los nombres de los autores o licenciantes del material con fines publicitarios o comerciales; o
  5926. +
  5927. +e) Negarse a ofrecer derechos bajo leyes de registro para el uso de algunos nombres comerciales, marcas registradas o marcas de servicio; o
  5928. +
  5929. +f) Exigir la compensación de los licenciantes y autores de ese material por cualquiera que distribuya el material (o versiones modificadas del mismo) estableciendo obligaciones contractuales de responsabilidad sobre el destinatario, por cualquier responsabilidad que estas obligaciones contractuales impongan directamente sobre los licenciantes y autores.
  5930. +
  5931. +Cualesquiera otras condiciones adicionales no-permisivas son consideradas "restricciones adicionales" en el contexto de la cláusula 10. Si el Programa, tal cual lo recibió, o cualquier parte del mismo, contiene un aviso indicando que está amparado por esta Licencia junto a una cláusula de restricción adicional, usted podrá suprimir esa cláusula. Si un documento de licencia contiene una restricción de este tipo pero permite modificar la Licencia o la transmisión de la obra en virtud de la presente Licencia, puede añadir material regido por esa licencia a una obra amparada, siempre que dicha restricción no se mantenga tras la modificación de la licencia o la transmisión.
  5932. +
  5933. +Si se añaden términos a una obra amparada de acuerdo con los términos de esta sección, debe colocar, en los archivos fuente involucrados, una declaración de los términos adicionales aplicables a esos archivos, o un aviso indicando donde encontrar los términos aplicables.
  5934. +
  5935. +Las condiciones adicionales, permisivas o no, deben aparecer por escrito como licencias separadas o figurar como excepciones; de todas formas, los requisitos anteriores se aplican igualmente.
  5936. +
  5937. +8. Cancelación
  5938. +
  5939. +Usted no podrá difundir o modificar una obra amparada salvo lo expresamente permitido por esta Licencia. Cualquier intento diferente de difusión o modificación será considerado nulo y automáticamente cancelará sus derechos respecto a esta Licencia (incluyendo cualquier patente conseguida según el párrafo tercero de la cláusula 11).
  5940. +
  5941. +Sin embargo, si usted deja de violar esta Licencia, entonces su Licencia desde el titular de los derechos de autor (“copyright”) correspondiente será restituida (a) provisionalmente, a menos que y hasta que el titular de los derechos de autor (“copyright”) explícita y permanentemente de por cancelada su licencia, y (b) permanentemente, si el titular del derecho de autor no le ha notificado su violación por algún medio razonable antes de los 60 días siguientes a la cesación.
  5942. +
  5943. +Además, su Licencia de un titular de los derechos de autor (“copyright”) correspondientes será restituida permanentemente si el titular de los derechos de autor (“copyright”) le notifica la violación por algún medio razonable, siendo ésta la primera vez que recibe la notificación de violación de esta Licencia (para cualquier obra) de ese titular de los derechos de autor (“copyright”), y usted subsana la violación antes de 30 días después de la recepción de la notificación.
  5944. +
  5945. +La cancelación de sus derechos bajo esta sección no da por canceladas las licencias de terceros que hayan recibido copias o derechos de usted bajo esta Licencia. Si sus derechos han sido cancelados y no fueran renovados de manera permanente, usted no cumple los requisitos para recibir nuevas licencias para el mismo material bajo la sección 10.
  5946. +
  5947. +9. Aceptación por Tenencia de Copias.
  5948. +
  5949. +No está obligado a aceptar esta Licencia por recibir o ejecutar una copia del Programa. La difusión de una obra amparada surgida simplemente como consecuencia de la transferencias de red entre pares o usuarios (peer-to-peer) para obtener una copia tampoco requiere aceptación. Sin embargo, únicamente esta Licencia le otorga permiso para difundir o modificar cualquier obra amparada. Estas acciones infringen los derechos de autor (“copyright”) si usted no acepta esta Licencia. Por lo tanto, al modificar o difundir una obra amparada, usted indica que acepta esta Licencia para hacerlo.
  5950. +
  5951. +10. Licencia Automática para Destinatarios Subsiguientes
  5952. +
  5953. +Cada vez que transmita una obra amparada, el destinatario recibirá automáticamente una Licencia desde los licenciadores originales, para ejecutar, modificar y difundir esa obra, al amparo de los términos de esta Licencia. Usted no será responsable de asegurar el cumplimiento por terceros de esta Licencia.
  5954. +
  5955. +Una “transacción de entidad” es una transacción que transfiere el control de una organización, o sustancialmente todos los bienes de una, o subdivide una organización, o fusiona organizaciones. Si la difusión de una obra amparada surge de una transacción de entidad, cada parte involucrada en esa transacción que reciba una copia de la obra, también recibe todas y cada una de las licencias existentes de la obra que la entidad precedente tuviese o pudiese ofrecer según el párrafo anterior, además del derecho a tomar posesión de la Fuente Correspondiente de la obra a través del predecesor interesado, si está en poder de dicha parte o se puede conseguir con un esfuerzo razonable.
  5956. +
  5957. +Usted no podrá imponer restricciones adicionales por el ejercicio de los derechos otorgados o concedidos en virtud de la presente Licencia, no podrá imponer a la Licencia pagos, derechos u otros cargos por la redistribución o modificación a los subsiguientes beneficiarios o destinatarios de la obra según los derechos otorgados bajo esta Licencia; además no podrá iniciar litigios (incluyendo demandas o contrademandas en pleitos) alegando que se infringen patentes por cambiar, usar, vender, ofrecer en venta o importar el Programa, o cualquier parte del mismo.
  5958. +
  5959. +11. Patentes
  5960. +
  5961. +Un “colaborador” es un titular de los derechos de autor (“copyright”) que autoriza, bajo los términos de la presente Licencia el uso del Programa o una obra en la que se base el Programa. La obra así licenciada se denomina “versión en colaboración” del colaborador.
  5962. +
  5963. +Las “demandas de patente esenciales” del colaborador son todas las reivindicaciones de patentes poseídas o controladas por el colaborador, existentes o adquiridas con posterioridad, que fueran infringidas de alguna forma, permitida por esta Licencia, al hacer, usar o vender la versión en colaboración, pero sin incluir demandas que sólo sean infringidas como consecuencia de modificaciones posteriores de la versión en colaboración. Para los propósitos de esta definición, “control” incluye el derecho de conceder sublicencias de patente de forma consistente con los requisitos establecidos en la presente Licencia.
  5964. +
  5965. +Cada colaborador le concede a usted una licencia de la patente no-exclusiva, global y libre de regalías bajo las demandas de patente esenciales del colaborador, para hacer, usar, modificar, vender, ofrecer para venta, importar y otras formas de ejecución, modificación y difusión del contenido de la versión en colaboración.
  5966. +
  5967. +En los siguientes tres párrafos, una “licencia de patente” se define como cualquier acuerdo o compromiso expreso, cualquiera que sea su denominación, que no imponga una patente (como el permiso expreso para ejecutar una patente o acuerdos para no imponer demandas por infracción de patente). “Conceder” una licencias de patente de este tipo a un tercero significa hacer tal tipo de acuerdo o compromiso de no imponer una patente a ningún tercero.
  5968. +
  5969. +Si usted transmite una obra amparada, conociendo que está amparada por una licencia de patente, y las Fuentes Correspondientes no se encuentran disponibles de forma pública para su copia, sin cargo alguno y bajo los términos de esta Licencia, ya sea a través de un servidor público o mediante cualquier otro medio, entonces usted deberá (1) hacer que las Fuentes Correspondientes sean públicas, o (2) tratar de eliminar los beneficios de la licencia de patente para esta obra en particular, o (3) tratar de extender, de manera compatible con los requisitos de esta Licencia, la licencia de patente a los terceros o destinatarios subsiguientes. “Conocer que está afectado” significa que usted tiene conocimiento real de que, para la licencia de patente, la transmisión de la obra amparada en un país, o el uso de la obra amparada por sus destinatarios en un país, infringiría una o más patentes existentes en ese país que usted considera válidas por algún motivo.
  5970. +
  5971. +Si, de conformidad con alguna transacción o acuerdo (o en un proceso relacionado con ellos), usted transmite o difunde con fines de distribución, una obra amparada, concediendo una licencia de patente para algún tercero que reciba la obra amparada, y autorizá a usar, difundir, modificar o transmitir una copia específica de la obra amparada, entonces la licencia de patente que usted otorgue se extiende automáticamente a todos los receptores de la obra amparada y cualquier obra basada en ella.
  5972. +
  5973. +Una licencia de patente es “discriminatoria” si no incluye en el marco de su cobertura los derechos otorgados por esta licencia, prohíbe el ejercicio o esta condicionada al no ejercicio de uno o mas de los derechos específicamente otorgados por esta licencia. Usted no debe transmitir una obra amparada si usted es parte de un acuerdo con una tercera parte involucrada en el negocio de distribución de software, bajo el cual usted debe realizar un pago a esa parte basado en el rango de su actividad de transmisión de la obra y bajo la cual la tercera parte adquiere, frente a cualquiera de las partes que pueda recibir de usted la obra, una licencia de patente discriminatoria (a) en conexión con copias de la obra amparada distribuida por usted (o copias hechas de esas copias), o (b) principalmente o en conexión con productos específicos o compilaciones que contienen la obra amparada.
  5974. +
  5975. +Nada en esta Licencia debe ser interpretado como excluyente o limitante a cualquier licencia implicada u otras defensas a la violación que puedan hacerse disponibles para usted bajo la ley de patentes aplicables.
  5976. +
  5977. +12. No Condicionamiento de la Libertad de Terceros
  5978. +
  5979. +Si a usted le son impuestas condiciones que contravienen las estipuladas en la presente Licencia (ya sea por orden judicial, acuerdo u otros), no quedará eximido de cumplir las condiciones de esta Licencia. Si usted no puede transmitir una obra amparada cumpliendo sus obligaciones con esta Licencia, entonces no podrá transmitirla de ninguna forma. Por ejemplo, si usted se compromete con términos que le obligan a obtener derechos por la transmisión que terceros a los cuales haya transmitido la obra amparada pudieran realizar, la única forma de satisfacer ambos condicionantes y esta Licencia es abstenerse completamente de transmitir el Programa.
  5980. +
  5981. +13. Versiones Actualizadas de esta Licencia
  5982. +
  5983. +La ADSIB puede publicar versiones revisadas y/o nuevas de la LPG - Bolivia. Cada nueva versión será similar en espíritu a la versión actual, pero puede diferir en detalles para abordar nuevos problemas o preocupaciones.
  5984. +
  5985. +Cada versión recibe un número de versión distintivo. Si el Programa especifica que cierta versión numerada de la Licencia General Pública Bolivia o cualquier versión posterior se aplica a él, usted tiene la opción de seguir los términos y condiciones de esa versión numerada o de cualquier versión posterior publicada por la ADSIB. Si el Programa no especifica un número de versión de la LPG - Bolivia, usted puede escoger cualquier versión publicada por la ADSIB.
  5986. +
  5987. +Si el Programa especifica que un apoderado/representante puede decidir qué versiones de la LPG - Bolivia pueden aplicarse en el futuro, la declaración pública de aceptación que el apoderado/representante haga de una versión le autoriza a usted con carácter permanente a elegir esa versión para el Programa.
  5988. +
  5989. +Las versiones posteriores de la Licencia pueden darle permisos adicionales o diferentes. No obstante, no se impone a ningún autor o titular de los derechos de autor obligaciones adicionales como resultado de su elección de seguir una versión posterior.
  5990. +
  5991. +14. Ausencia de Garantía
  5992. +
  5993. +EL PROGRAMA NO TIENE GARANTÍA ALGUNA, HASTA LOS LÍMITES PERMITIDOS POR LAS LEYES APLICABLES. SALVO CUANDO SE ESTABLEZCA LO CONTRARIO POR ESCRITO, LOS TITULARES DE LOS DERECHOS DE AUTOR (“COPYRIGHT”) Y/O TERCEROS PROPORCIONAN EL PROGRAMA “TAL CUAL” SIN GARANTÍAS DE NINGÚN TIPO, BIEN SEAN EXPLÍCITAS O IMPLÍCITAS, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS IMPLÍCITAS DE COMERCIALIZACIÓN Y APTITUD PARA UN PROPÓSITO PARTICULAR. USTED ASUMIRÁ CUALQUIER RIESGO RELATIVO A LA CALIDAD Y RENDIMIENTO DEL PROGRAMA. SI EL PROGRAMA FUESE DEFECTUOSO, USTED ASUMIRÁ CUALQUIER COSTE DE SERVICIO, REPARACIÓN O CORRECCIÓN.
  5994. +
  5995. +15. Límite de responsabilidad
  5996. +
  5997. +EN NINGÚN CASO, SALVO REQUERIMIENTO POR LEYES APLICABLES O MEDIANTE ACUERDO POR ESCRITO NINGÚN TITULAR DE LOS DERECHOS DE AUTOR (“COPYRIGHT”), O NINGÚN TERCERO QUE MODIFIQUE Y/O DISTRIBUYA EL PROGRAMA SEGÚN LO INDICADO ANTERIORMENTE, PODRÁ HACERLE A USTED RESPONSABLE DE DAÑO ALGUNO, INCLUYENDO CUALQUIER DAÑO GENERAL, ESPECIAL, OCASIONAL O DERIVADO QUE SURJA DEL USO O LA INCAPACIDAD DE USO DEL PROGRAMA (INCLUYENDO PERO SIN LIMITARSE A LA PÉRDIDA DE DATOS O LA PRESENTACIÓN NO PRECISA DE LOS MISMOS O A PÉRDIDAS SUFRIDAS POR USTED O TERCEROS O AL FALLO DEL PROGRAMA AL INTERACTUAR CON OTROS PROGRAMAS), INCLUSO SI DICHO TITULAR O UN TERCERO HA SIDO ADVERTIDO DE LA POSIBILIDAD DE TALES DAÑOS.
  5998. +
  5999. +16. Interpretación de las Cláusulas 14 y 15
  6000. +
  6001. +Si el descargo de responsabilidad de garantía y el límite de responsabilidad proporcionado anteriormente no tiene efectos legales de acuerdo a sus términos, los juzgados deberán aplicar la ley local que más se asemeje a una renuncia absoluta de la responsabilidad civil concerniente al Programa, a menos que una garantía o una asunción de responsabilidad acompañe a la copia del Programa como resultado del pago de una tasa.
  6002. +
  6003. +17. Del Licenciamiento GNU GPL.
  6004. +
  6005. +La presente licencia ha sido traducida y adaptada para la publicación y distribución de software libre por parte de las entidades públicas del Estado Plurinacional de Bolivia en el Repositorio Estatal de Software Libre, conforme a lo establecido por la Ley No. 164 y el D.S. 1793, y busca ser lo más fiel posible a la letra y espíritu de la GNU GPL. No obstante, como salvaguarda, todo usuario esta autorizado a licenciar bajo la GNU GPL, publicada de forma oficial por la Fundación para el Software Libre en su página web www.fsf.org, cualquier obra que reciba bajo la presente licencia, según la legislación legal correspondiente.
  6006. +
  6007. +
  6008. +**FIN DE TÉRMINOS Y CONDICIONES**
  6009. diff --git "a/docs/evaluacionCargoEtapa/evaluaci\303\263nCargoEtapa.rst" b/docs/reserva/reserva.rst
  6010. similarity index 60%
  6011. rename from "docs/evaluacionCargoEtapa/evaluaci\303\263nCargoEtapa.rst"
  6012. rename to docs/reserva/reserva.rst
  6013. index 1015a0b..9edb393 100644
  6014. --- "a/docs/evaluacionCargoEtapa/evaluaci\303\263nCargoEtapa.rst"
  6015. +++ b/docs/reserva/reserva.rst
  6016. @@ -1,5 +1,5 @@
  6017. -Evaluación Cargo Etapa
  6018. -======================
  6019. +Reserva
  6020. +====================
  6021.  
  6022. Formato URL
  6023. ------------------------
  6024. @@ -20,31 +20,27 @@ Ejemplo
  6025.  
  6026. **Contenido Body**
  6027.  
  6028. -Contenido en data del cuerpo para realizar el creado ó actualización de un registro identificado como :id (Identificador único del registro).
  6029. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  6030.  
  6031. .. code:: json
  6032.  
  6033. - {
  6034. - "fecha_creacion": "2016-07-04T14:04:23.583Z",
  6035. - "fecha_modificacion": "2016-07-04T14:04:23.583Z",
  6036. - "fk_evaluacion": 7, // servidores web
  6037. - "fk_cargo_convocatoria": 1, // cargo: Seguridad Informática e Incidentes Informáticos I, convocatoria: Se requiere personal en el área de desarrollo y seguridad informática
  6038. - "fk_etapa": 2 // Evaluación requerimiento de personal (15 de marzo)
  6039. - }
  6040. -
  6041. -
  6042. -+----------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------------+
  6043. -|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  6044. -+========================================+=====================================================================+====================================================+=====================================================+====================================================+
  6045. -| `/evaluacionesCargosEtapas` | Obtiene el listado de todas las Evaluaciones Cargo Etapa | Crea un registro de Evaluaciones Cargo Etapa | | |
  6046. -+----------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------------+
  6047. -| `/evaluacionesCargosEtapas/:id` | Obtiene la etapas identificado como :id | | Actualiza registro :id de Evaluaciones Cargo Etapa | Elimina registro :id de Evaluaciones Cargo Etapa |
  6048. -+----------------------------------------+---------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------------+----------------------------------------------------+
  6049. -
  6050. + {
  6051. + "fecha_creacion": "2016-04-27T20:58:20.042Z",
  6052. + "fecha_modificacion": "2016-04-27T20:58:20.042Z",
  6053. + "fk_persona": 1202, //Jesus Adrian Romero
  6054. + "fk_cargo": 1380 //Desarrollador de Sistemas 1
  6055. + }
  6056. +
  6057. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6058. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  6059. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  6060. +| /reservas | Obtiene el listado de todos las Reservas | Crea un registro de Reserva | | |
  6061. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6062. +| /reservas/:id | Obtiene la Reserva identificado como :id | | Actualiza registro :id de Reserva | Elimina registro :id de Reserva |
  6063. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6064.  
  6065. Respuestas
  6066. ----------
  6067. -
  6068. +------------------+----------------------------------------------------------------------------------------------+
  6069. | **Código HTTP** | **Descripción** |
  6070. +==================+==============================================================================================+
  6071. diff --git a/docs/tag/tag.rst b/docs/tag/tag.rst
  6072. index fcfe9b2..85822c7 100644
  6073. --- a/docs/tag/tag.rst
  6074. +++ b/docs/tag/tag.rst
  6075. @@ -1,68 +1,46 @@
  6076. Tag
  6077. -===
  6078. +====================
  6079.  
  6080. -Mostrar todos los tags
  6081. -----------------------
  6082. +Formato URL
  6083. +------------------------
  6084. ++-----------------+-------------------------+
  6085. +|**Método HTTP** |**Significado** |
  6086. ++=================+=========================+
  6087. +|`GET` | Obtiene un recurso |
  6088. ++-----------------+-------------------------+
  6089. +|`POST` | Crea un recurso |
  6090. ++-----------------+-------------------------+
  6091. +|`PUT` | Actualiza un recurso |
  6092. ++-----------------+-------------------------+
  6093. +|`DELETE` | Borra un recurso |
  6094. ++-----------------+-------------------------+
  6095.  
  6096. -URL
  6097. -```
  6098. -::
  6099. +Ejemplo
  6100. +''''''''''''
  6101.  
  6102. - /tags
  6103. +**Contenido Body**
  6104.  
  6105. -Método
  6106. -``````
  6107. -``GET``
  6108. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  6109.  
  6110. -Respuesta correcta
  6111. -``````````````````
  6112. -
  6113. -**Código:** 200
  6114. +.. code:: json
  6115.  
  6116. -**Contenido:**
  6117. + {
  6118. + "nombre": "javascript",
  6119. + "fecha_creacion": "2016-04-27T20:58:20.042Z",
  6120. + "fecha_modificacion": "2016-04-27T20:58:20.042Z"
  6121. + }
  6122.  
  6123. -.. code:: json
  6124. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6125. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  6126. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  6127. +| /tags | Obtiene el listado de todos los Tags | Crea un registro de Tag | | |
  6128. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6129. +| /tags/:id | Obtiene el Tag identificado como :id | | Actualiza registro :id de Tag | Elimina registro :id de Tag |
  6130. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  6131.  
  6132. - {
  6133. - "count":5,"rows":
  6134. - [
  6135. - {
  6136. - "_id": 187,
  6137. - "nombre": "C++",
  6138. - "fecha_creacion": "2016-03-16T15:50:28.626Z",
  6139. - "fecha_modificacion": "2016-03-16T15:50:28.626Z"
  6140. - },
  6141. - {
  6142. - "_id": 188,
  6143. - "nombre": "Python",
  6144. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  6145. - "fecha_modificacion": "2016-03-16T15:50:28.628Z"
  6146. - },
  6147. - {
  6148. - "_id": 189,
  6149. - "nombre": "Java",
  6150. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6151. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6152. - },
  6153. - {
  6154. - "_id": 190,
  6155. - "nombre": "PHP",
  6156. - "fecha_creacion": "2016-03-16T15:50:28.630Z",
  6157. - "fecha_modificacion": "2016-03-16T15:50:28.630Z"
  6158. - },
  6159. - {
  6160. - "_id": 191,
  6161. - "nombre": "Ruby",
  6162. - "fecha_creacion": "2016-03-16T15:50:28.632Z",
  6163. - "fecha_modificacion": "2016-03-16T15:50:28.632Z"
  6164. - }
  6165. - ]
  6166. - }
  6167.  
  6168. -Parámetros opcionales de la URL
  6169. -```````````````````````````````
  6170. -Tabla de parámetros
  6171. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6172. +Tabla de parámetros opcionales de la URL para peticines GET
  6173. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6174. +-+-----------+------------------+---------------------------------------------------------------------+
  6175. |**Nombre** |**Tipo** |**Descripción** |
  6176. +=+===========+==================+=====================================================================+
  6177. @@ -87,647 +65,25 @@ Tabla de parámetros
  6178. | |`entidad` | String |El nombre de la entidad. |
  6179. +-+-----------+------------------+---------------------------------------------------------------------+
  6180.  
  6181. -Muestra una determinada cantidad de tags
  6182. -''''''''''''''''''''''''''''''''''''''''
  6183. -
  6184. -**URL**
  6185. -::
  6186. -
  6187. - /tags?elementos=valor
  6188. -
  6189. -**Parámetros usados**
  6190. -
  6191. -============ =====================
  6192. -**Nombre** **Valor enviado**
  6193. -============ =====================
  6194. -`elementos` 1
  6195. -============ =====================
  6196. -
  6197. -**Ejemplo:**
  6198. -::
  6199. -
  6200. - /tags?elementos=3
  6201. -
  6202. -**Respuesta:**
  6203. -
  6204. -.. code:: json
  6205. -
  6206. - {
  6207. - "count":5,"rows":
  6208. - [
  6209. - {
  6210. - "_id": 187,
  6211. - "nombre": "C++",
  6212. - "fecha_creacion": "2016-03-16T15:50:28.626Z",
  6213. - "fecha_modificacion": "2016-03-16T15:50:28.626Z"
  6214. - },
  6215. - {
  6216. - "_id": 188,
  6217. - "nombre": "Python",
  6218. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  6219. - "fecha_modificacion": "2016-03-16T15:50:28.628Z"
  6220. - },
  6221. - {
  6222. - "_id": 189,
  6223. - "nombre": "Java",
  6224. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6225. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6226. - }
  6227. - ]
  6228. - }
  6229. -
  6230. -Muestra los tags en una determinada página
  6231. -''''''''''''''''''''''''''''''''''''''''''
  6232. -
  6233. -**URL**
  6234. -::
  6235. -
  6236. - /tags?pagina=valor
  6237. -
  6238. -**Parámetros usados**
  6239. -
  6240. -============ =====================
  6241. -**Nombre** **Valor enviado**
  6242. -============ =====================
  6243. -`pagina` 1
  6244. -============ =====================
  6245. -
  6246. -**Ejemplo:**
  6247. -::
  6248. -
  6249. - /tags?pagina=1
  6250. -
  6251. -**Respuesta:**
  6252. -
  6253. -.. code:: json
  6254. -
  6255. - {
  6256. - "count":5,"rows":
  6257. - [
  6258. - {
  6259. - "_id": 187,
  6260. - "nombre": "C++",
  6261. - "fecha_creacion": "2016-03-16T15:50:28.626Z",
  6262. - "fecha_modificacion": "2016-03-16T15:50:28.626Z"
  6263. - },
  6264. - {
  6265. - "_id": 188,
  6266. - "nombre": "Python",
  6267. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  6268. - "fecha_modificacion": "2016-03-16T15:50:28.628Z"
  6269. - },
  6270. - {
  6271. - "_id": 189,
  6272. - "nombre": "Java",
  6273. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6274. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6275. - },
  6276. - {
  6277. - "_id": 190,
  6278. - "nombre": "PHP",
  6279. - "fecha_creacion": "2016-03-16T15:50:28.630Z",
  6280. - "fecha_modificacion": "2016-03-16T15:50:28.630Z"
  6281. - },
  6282. - {
  6283. - "_id": 191,
  6284. - "nombre": "Ruby",
  6285. - "fecha_creacion": "2016-03-16T15:50:28.632Z",
  6286. - "fecha_modificacion": "2016-03-16T15:50:28.632Z"
  6287. - }
  6288. - ]
  6289. - }
  6290. -
  6291. -Ordena los tags ascendentemente en base a un campo del modelo
  6292. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6293. -
  6294. -**URL**
  6295. -::
  6296. -
  6297. - /tags?ordenarPor=valor
  6298. -
  6299. -**Parámetros usados**
  6300. -
  6301. -============ =====================
  6302. -**Nombre** **Valor enviado**
  6303. -============ =====================
  6304. -`ordenarPor` nombre
  6305. -============ =====================
  6306. -
  6307. -**Ejemplo:**
  6308. -::
  6309. -
  6310. - /tags?ordenarPor=nombre
  6311. -
  6312. -**Respuesta:**
  6313. -
  6314. -.. code:: json
  6315. -
  6316. - {
  6317. - "count":5,"rows":
  6318. - [
  6319. - {
  6320. - "_id": 187,
  6321. - "nombre": "C++",
  6322. - "fecha_creacion": "2016-03-16T15:50:28.626Z",
  6323. - "fecha_modificacion": "2016-03-16T15:50:28.626Z"
  6324. - },
  6325. - {
  6326. - "_id": 189,
  6327. - "nombre": "Java",
  6328. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6329. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6330. - },
  6331. - {
  6332. - "_id": 190,
  6333. - "nombre": "PHP",
  6334. - "fecha_creacion": "2016-03-16T15:50:28.630Z",
  6335. - "fecha_modificacion": "2016-03-16T15:50:28.630Z"
  6336. - },
  6337. - {
  6338. - "_id": 188,
  6339. - "nombre": "Python",
  6340. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  6341. - "fecha_modificacion": "2016-03-16T15:50:28.628Z"
  6342. - },
  6343. - {
  6344. - "_id": 191,
  6345. - "nombre": "Ruby",
  6346. - "fecha_creacion": "2016-03-16T15:50:28.632Z",
  6347. - "fecha_modificacion": "2016-03-16T15:50:28.632Z"
  6348. - }
  6349. - ]
  6350. - }
  6351. -
  6352. -Ordena los tags descendentemente en base a un campo del modelo
  6353. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6354. -
  6355. -**URL**
  6356. -::
  6357. -
  6358. - /tags?ordenarPor=valor1&orden=true
  6359. -
  6360. -**Parámetros usados**
  6361. -
  6362. -============ =================
  6363. -**Nombre** **Valor enviado**
  6364. -============ =================
  6365. -`ordenarPor` nombre
  6366. -`orden` true
  6367. -============ =================
  6368. -
  6369. -**Ejemplo:**
  6370. -::
  6371. -
  6372. - /tags?ordenarPor=nombre&orden=true
  6373. -
  6374. -**Respuesta:**
  6375. -
  6376. -.. code:: json
  6377. -
  6378. - {
  6379. - "count":5,"rows":
  6380. - [
  6381. - {
  6382. - "_id": 191,
  6383. - "nombre": "Ruby",
  6384. - "fecha_creacion": "2016-03-16T15:50:28.632Z",
  6385. - "fecha_modificacion": "2016-03-16T15:50:28.632Z"
  6386. - },
  6387. - {
  6388. - "_id": 188,
  6389. - "nombre": "Python",
  6390. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  6391. - "fecha_modificacion": "2016-03-16T15:50:28.628Z"
  6392. - },
  6393. - {
  6394. - "_id": 190,
  6395. - "nombre": "PHP",
  6396. - "fecha_creacion": "2016-03-16T15:50:28.630Z",
  6397. - "fecha_modificacion": "2016-03-16T15:50:28.630Z"
  6398. - },
  6399. - {
  6400. - "_id": 189,
  6401. - "nombre": "Java",
  6402. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6403. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6404. - },
  6405. - {
  6406. - "_id": 187,
  6407. - "nombre": "C++",
  6408. - "fecha_creacion": "2016-03-16T15:50:28.626Z",
  6409. - "fecha_modificacion": "2016-03-16T15:50:28.626Z"
  6410. - }
  6411. - ]
  6412. - }
  6413. -
  6414. -Busca los Tags que contenga la palabra "Java"
  6415. -'''''''''''''''''''''''''''''''''''''''''''''
  6416. -
  6417. -**URL**
  6418. -::
  6419. -
  6420. - /tags?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  6421. -
  6422. -**Parámetros usados**
  6423. -
  6424. -============ ===========================================
  6425. -**Nombre** **Valor enviado**
  6426. -============ ===========================================
  6427. -`buscar` ::
  6428. -
  6429. - [{"en":"nombre","palabra":"Java"}]
  6430. -============ ===========================================
  6431. -
  6432. -**Ejemplo:**
  6433. -::
  6434. -
  6435. - /tags?buscar=%7B%22en%22:%22nombre%22,%22palabra%22:%22Java%22%7D
  6436. -
  6437. -**Respuesta:**
  6438. -
  6439. -.. code:: json
  6440. -
  6441. - {
  6442. - "count":5,"rows":
  6443. - [
  6444. - {
  6445. - "_id": 189,
  6446. - "nombre": "Java",
  6447. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6448. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  6449. - }
  6450. - ]
  6451. - }
  6452. -
  6453. -Muestra las personas que tienen el Tag "Java"
  6454. -''''''''''''''''''''''''''''''''''''''''''''''''
  6455. -
  6456. -**URL**
  6457. -::
  6458. -
  6459. - /tags?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D&incluye=%7B%22entidad%22:%22valor3%22%7D
  6460. -
  6461. -**Parámetros usados**
  6462. -
  6463. -============ ===========================================
  6464. -**Nombre** **Valor enviado**
  6465. -============ ===========================================
  6466. -`buscar` ::
  6467. -
  6468. - [{"en":"nombre","palabra":"java"}]
  6469. -
  6470. -`incluye` ::
  6471. -
  6472. - [{"entidad":"persona"}]
  6473. -============ ===========================================
  6474. -
  6475. -**Ejemplo:**
  6476. -::
  6477. -
  6478. - /tags?buscar=%7B%22en%22:%22nombre%22,%22palabra%22:%22java%22%7D&incluye=%7B%22entidad%22:%22persona%22%7D
  6479. -
  6480. -**Respuesta:**
  6481. -
  6482. -.. code:: json
  6483. -
  6484. - {
  6485. - "count":5,"rows":
  6486. - [
  6487. - {
  6488. - "_id": 189,
  6489. - "nombre": "Java",
  6490. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  6491. - "fecha_modificacion": "2016-03-16T15:50:28.629Z",
  6492. - "Personas":
  6493. - [
  6494. - {
  6495. - "_id": 220,
  6496. - "nombres": "Carlos Alberto",
  6497. - "apellidos": "Vargas Nina",
  6498. - "ci": 6845231,
  6499. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  6500. - "fecha_modificacion": "2016-01-14T22:52:31.554Z",
  6501. - "TagPersona":
  6502. - {
  6503. - "_id": 63,
  6504. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  6505. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  6506. - "fk_persona": 220,
  6507. - "fk_tag": 189
  6508. - }
  6509. - },
  6510. - {
  6511. - "_id": 560,
  6512. - "nombres": "Damian Teodoro",
  6513. - "apellidos": "Soliz Antequera",
  6514. - "ci": 129855,
  6515. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  6516. - "fecha_modificacion": "2016-01-14T22:52:31.554Z",
  6517. - "TagPersona":
  6518. - {
  6519. - "_id": 63,
  6520. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  6521. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  6522. - "fk_persona": 560,
  6523. - "fk_tag": 189
  6524. - }
  6525. - }
  6526. - ]
  6527. - }
  6528. - ]
  6529. - }
  6530. -
  6531. -Respuesta de error
  6532. -``````````````````
  6533. -
  6534. -**Código:** 500
  6535. -
  6536. -**Contenido:**
  6537. -
  6538. -.. code:: json
  6539. -
  6540. - {
  6541. - "error":"Ocurrio un problema inesperado en el servidor"
  6542. - }
  6543. -
  6544. -Observaciones
  6545. -`````````````
  6546. -- Cuando no existen datos almacenados en la base de datos retorna un array vacio
  6547. -- El parámetro 'orden' depende de 'ordenarPor'
  6548. -- El parámetro 'pagina' muestra 15 tags por defecto
  6549. -
  6550. -----
  6551. -
  6552. -Crear un tag
  6553. -------------
  6554. -
  6555. -URL
  6556. -```
  6557. -::
  6558. -
  6559. - /tags
  6560. -
  6561. -Método
  6562. -``````
  6563. -``POST``
  6564. -
  6565. -Parámetros del body
  6566. -```````````````````
  6567. -**Ejemplo:**
  6568. -
  6569. -.. code:: json
  6570. -
  6571. - {
  6572. - "nombre": "Javascript"
  6573. - }
  6574. -
  6575. -Respuesta correcta
  6576. -``````````````````
  6577. -
  6578. -**Código:**
  6579. -201
  6580. -
  6581. -**Ejemplo:**
  6582. -
  6583. -.. code:: json
  6584. -
  6585. - {
  6586. - "_id": 192,
  6587. - "nombre": "Javascript",
  6588. - "fecha_modificacion": "2016-03-16T16:07:29.322Z",
  6589. - "fecha_creacion": "2016-03-16T16:07:29.322Z"
  6590. - }
  6591. -
  6592. -Respuesta de error
  6593. -``````````````````
  6594. -
  6595. -**Código:** 409
  6596. -
  6597. -**Contenido:**
  6598. -
  6599. -.. code:: json
  6600. -
  6601. - {
  6602. - "name": "SequelizeUniqueConstraintError",
  6603. - "message": "El objeto ya existe",
  6604. - "errors": {}
  6605. - }
  6606. -
  6607. -**Código:** 400
  6608. -
  6609. -**Contenido:**
  6610. -
  6611. -.. code:: json
  6612. -
  6613. - {
  6614. - "name": "SequelizeValidationError",
  6615. - "message": "Validation error: Por favor ingrese un nombre para el tag",
  6616. - "errors": [
  6617. - {
  6618. - "message": "Por favor ingrese un nombre para el tag",
  6619. - "type": "Validation error",
  6620. - "path": "nombre",
  6621. - "value": {},
  6622. - "__raw": {}
  6623. - }
  6624. - ]
  6625. - }
  6626. -
  6627. -----
  6628. -
  6629. -Mostrar un tag
  6630. ---------------
  6631. -
  6632. -URL
  6633. -```
  6634. -::
  6635. -
  6636. - /tags/:id
  6637. -
  6638. -Método
  6639. -``````
  6640. -``GET``
  6641. -
  6642. -Parámetros de la URL
  6643. -````````````````````
  6644. -
  6645. -**Parámetro requerido:**
  6646. -
  6647. -============ ============== ================================================
  6648. -**Nombre** **Tipo** **Descripción**
  6649. -============ ============== ================================================
  6650. -`id` Integer Identificador único del registro en la entidad.
  6651. -============ ============== ================================================
  6652. -
  6653. -**Ejemplo:**
  6654. -::
  6655. -
  6656. - id=192
  6657. -
  6658. -Respuesta correcta
  6659. -``````````````````
  6660. -
  6661. -**Código:** 200
  6662. -
  6663. -**Contenido:**
  6664. -
  6665. -.. code:: json
  6666. -
  6667. - {
  6668. - "_id": 192,
  6669. - "nombre": "Javascript",
  6670. - "fecha_modificacion": "2016-03-16T16:07:29.322Z",
  6671. - "fecha_creacion": "2016-03-16T16:07:29.322Z"
  6672. - }
  6673. -
  6674. -Respuesta de error
  6675. -``````````````````
  6676. -
  6677. -**Código:** 404
  6678. -
  6679. -**Contenido:**
  6680. -
  6681. -.. code:: json
  6682. -
  6683. - {
  6684. - "message": "Entidad no encontrada"
  6685. - }
  6686. -
  6687. -----
  6688. -
  6689. -Editar un tag
  6690. --------------
  6691. -
  6692. -URL
  6693. -```
  6694. -::
  6695. -
  6696. - /tag/:id
  6697. -
  6698. -Método
  6699. -``````
  6700. -``PUT``
  6701. -
  6702. -Parámetros de la URL
  6703. -````````````````````
  6704. -
  6705. -**Parámetro requerido:**
  6706. -
  6707. -============ ============== ================================================
  6708. -**Nombre** **Tipo** **Descripción**
  6709. -============ ============== ================================================
  6710. -`id` Integer Identificador único del registro en la entidad.
  6711. -============ ============== ================================================
  6712. -
  6713. -**Ejemplo:**
  6714. -::
  6715. -
  6716. - id=192
  6717. -
  6718. -Parámetros del body
  6719. -```````````````````
  6720. -**Ejemplo:**
  6721. -
  6722. -.. code:: json
  6723. -
  6724. - {
  6725. - "nombre":"git"
  6726. - }
  6727. -
  6728. -Respuesta correcta
  6729. -``````````````````
  6730. -
  6731. -**Código:** 200
  6732. -
  6733. -**Ejemplo:**
  6734. -
  6735. -.. code:: json
  6736. -
  6737. - {
  6738. - "_id": 192,
  6739. - "nombre": "git",
  6740. - "fecha_modificacion": "2016-03-16T16:07:29.322Z",
  6741. - "fecha_creacion": "2016-03-16T16:07:29.322Z"
  6742. - }
  6743. -
  6744. -Respuesta de error
  6745. -``````````````````
  6746. -
  6747. -**Código:** 404
  6748. -
  6749. -**Contenido:**
  6750. -
  6751. -.. code:: json
  6752. -
  6753. - {
  6754. - "message": "Entidad no encontrada"
  6755. - }
  6756. -
  6757. -**Código:** 400
  6758. -
  6759. -**Contenido:**
  6760. -
  6761. -.. code:: json
  6762. -
  6763. - {
  6764. - "name": "SequelizeValidationError",
  6765. - "message": "Validation error: Por favor ingrese un nombre para el tag",
  6766. - "errors": [
  6767. - {
  6768. - "message": "Por favor ingrese un nombre para el tag",
  6769. - "type": "Validation error",
  6770. - "path": "nombre",
  6771. - "value": {},
  6772. - "__raw": {}
  6773. - }
  6774. - ]
  6775. - }
  6776. -
  6777. -----
  6778. -
  6779. -Eliminar un tag
  6780. ----------------
  6781. -
  6782. -URL
  6783. -```
  6784. -::
  6785. -
  6786. - /tags/:id
  6787. -
  6788. -Método
  6789. -``````
  6790. -``DELETE``
  6791. -
  6792. -Parámetros de la URL
  6793. -````````````````````
  6794. -
  6795. -**Parámetro requerido:**
  6796. -
  6797. -============ ============== ================================================
  6798. -**Nombre** **Tipo** **Descripción**
  6799. -============ ============== ================================================
  6800. -`id` Integer Identificador único del registro en la entidad.
  6801. -============ ============== ================================================
  6802. -
  6803. -**Ejemplo:**
  6804. -::
  6805. -
  6806. - id=192
  6807. -
  6808. -Respuesta correcta
  6809. -``````````````````
  6810. -
  6811. -**Código:** 204
  6812. -
  6813. -Respuesta de error
  6814. -``````````````````
  6815. -
  6816. -**Código:** 404
  6817. -
  6818. -**Contenido:**
  6819. -
  6820. -.. code:: json
  6821. -
  6822. - {
  6823. - "message": "Entidad no encontrada"
  6824. - }
  6825. +Respuestas
  6826. +----------
  6827. +
  6828. ++------------------+----------------------------------------------------------------------------------------------+
  6829. +| **Código HTTP** | **Descripción** |
  6830. ++==================+==============================================================================================+
  6831. +| `200` | Ok |
  6832. ++------------------+----------------------------------------------------------------------------------------------+
  6833. +| `201` | Creado |
  6834. ++------------------+----------------------------------------------------------------------------------------------+
  6835. +| `400` | Parámetros incorrectos en la entrada |
  6836. ++------------------+----------------------------------------------------------------------------------------------+
  6837. +| `401` | Token de acceso expirado o invalido |
  6838. ++------------------+----------------------------------------------------------------------------------------------+
  6839. +| `404` | Recurso no encontrado |
  6840. ++------------------+----------------------------------------------------------------------------------------------+
  6841. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  6842. ++------------------+----------------------------------------------------------------------------------------------+
  6843. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  6844. ++------------------+----------------------------------------------------------------------------------------------+
  6845. +| `500` | Error interno del servidor |
  6846. ++------------------+----------------------------------------------------------------------------------------------+
  6847. diff --git a/docs/tagPersona/tagPersona.rst b/docs/tagPersona/tagPersona.rst
  6848. index f1d25ca..73b71b3 100644
  6849. --- a/docs/tagPersona/tagPersona.rst
  6850. +++ b/docs/tagPersona/tagPersona.rst
  6851. @@ -1,810 +1,63 @@
  6852. -Relación entre Tag y Persona
  6853. -===============================
  6854. -
  6855. -Mostrar todas las relaciones entre tags y personas
  6856. ------------------------------------------------------
  6857. -
  6858. -URL
  6859. -```
  6860. -::
  6861. -
  6862. - /tagsPersonas
  6863. -
  6864. -Método
  6865. -``````
  6866. -``GET``
  6867. -
  6868. -Respuesta correcta
  6869. -``````````````````
  6870. -
  6871. -**Código:** 200
  6872. -
  6873. -**Contenido:**
  6874. -
  6875. -.. code:: json
  6876. -
  6877. - {
  6878. - "count":3,"rows":
  6879. - [
  6880. - {
  6881. - "_id": 63,
  6882. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  6883. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  6884. - "fk_persona": 250,
  6885. - "fk_tag": 190
  6886. - },
  6887. - {
  6888. - "_id": 64,
  6889. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  6890. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  6891. - "fk_persona": 247,
  6892. - "fk_tag": 188
  6893. - },
  6894. - {
  6895. - "_id": 65,
  6896. - "fecha_creacion": "2016-03-16T15:50:28.753Z",
  6897. - "fecha_modificacion": "2016-03-16T15:50:28.753Z",
  6898. - "fk_persona": 248,
  6899. - "fk_tag": 189
  6900. - }
  6901. - ]
  6902. - }
  6903. -
  6904. -Parámetros opcionales de la URL
  6905. -```````````````````````````````
  6906. -Tabla de parámetros
  6907. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6908. -+-+-----------+------------------+---------------------------------------------------------------------+
  6909. -|**Nombre** |**Tipo** |**Descripción** |
  6910. -+=+===========+==================+=====================================================================+
  6911. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  6912. -+-+-----------+------------------+---------------------------------------------------------------------+
  6913. -|`pagina` | Integer |El número de página a mostrar. |
  6914. -+-+-----------+------------------+---------------------------------------------------------------------+
  6915. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  6916. -+-+-----------+------------------+---------------------------------------------------------------------+
  6917. -|`orden` | Boolean |TRUE para un orden descendente. |
  6918. -+-+-----------+------------------+---------------------------------------------------------------------+
  6919. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  6920. -+-+-----------+------------------+---------------------------------------------------------------------+
  6921. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  6922. -+-+-----------+------------------+---------------------------------------------------------------------+
  6923. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  6924. -+-+-----------+------------------+---------------------------------------------------------------------+
  6925. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  6926. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  6927. -| | |`buscar` definido anteriormente) |
  6928. -+-+-----------+------------------+---------------------------------------------------------------------+
  6929. -| |`entidad` | String |El nombre de la entidad. |
  6930. -+-+-----------+------------------+---------------------------------------------------------------------+
  6931. -
  6932. -Muestra una determinada cantidad de relaciones entre un tag y una persona
  6933. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6934. -
  6935. -**URL**
  6936. -::
  6937. -
  6938. - /tagsPersonas?elementos=valor
  6939. -
  6940. -**Parámetros usados**
  6941. -
  6942. -============ =====================
  6943. -**Nombre** **Valor enviado**
  6944. -============ =====================
  6945. -`elementos` 1
  6946. -============ =====================
  6947. -
  6948. -**Ejemplo:**
  6949. -::
  6950. -
  6951. - /tagsPersonas?elementos=2
  6952. -
  6953. -**Respuesta:**
  6954. -
  6955. -.. code:: json
  6956. -
  6957. - {
  6958. - "count":3,"rows":
  6959. - [
  6960. - {
  6961. - "_id": 63,
  6962. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  6963. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  6964. - "fk_persona": 250,
  6965. - "fk_tag": 190
  6966. - },
  6967. - {
  6968. - "_id": 64,
  6969. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  6970. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  6971. - "fk_persona": 247,
  6972. - "fk_tag": 188
  6973. - }
  6974. - ]
  6975. - }
  6976. -
  6977. -Muestra las relaciones entre un tag y una persona en una determinada página
  6978. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  6979. -
  6980. -**URL**
  6981. -::
  6982. -
  6983. - /tagsPersonas?pagina=valor
  6984. -
  6985. -**Parámetros usados**
  6986. -
  6987. -============ =====================
  6988. -**Nombre** **Valor enviado**
  6989. -============ =====================
  6990. -`pagina` 1
  6991. -============ =====================
  6992. -
  6993. -**Ejemplo:**
  6994. -::
  6995. -
  6996. - /tagsPersonas?pagina=1
  6997. -
  6998. -**Respuesta:**
  6999. -
  7000. -.. code:: json
  7001. -
  7002. - {
  7003. - "count":3,"rows":
  7004. - [
  7005. - {
  7006. - "_id": 63,
  7007. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  7008. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  7009. - "fk_persona": 250,
  7010. - "fk_tag": 190
  7011. - },
  7012. - {
  7013. - "_id": 64,
  7014. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  7015. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  7016. - "fk_persona": 247,
  7017. - "fk_tag": 188
  7018. - },
  7019. - {
  7020. - "_id": 65,
  7021. - "fecha_creacion": "2016-03-16T15:50:28.753Z",
  7022. - "fecha_modificacion": "2016-03-16T15:50:28.753Z",
  7023. - "fk_persona": 248,
  7024. - "fk_tag": 189
  7025. - }
  7026. - ]
  7027. - }
  7028. -
  7029. -Ordena las relaciones entre un tag y una persona ascendentemente en base a un campo del modelo
  7030. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  7031. -
  7032. -**URL**
  7033. -::
  7034. -
  7035. - /tagsPersonas?ordenarPor=valor
  7036. -
  7037. -**Parámetros usados**
  7038. -
  7039. -============ =====================
  7040. -**Nombre** **Valor enviado**
  7041. -============ =====================
  7042. -`ordenarPor` fk_persona
  7043. -============ =====================
  7044. -
  7045. -**Ejemplo:**
  7046. -::
  7047. -
  7048. - /tagsPersonas?ordernarPor=fk_persona
  7049. -
  7050. -**Respuesta:**
  7051. -
  7052. -.. code:: json
  7053. -
  7054. - {
  7055. - "count":3,"rows":
  7056. - [
  7057. - {
  7058. - "_id": 64,
  7059. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  7060. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  7061. - "fk_persona": 247,
  7062. - "fk_tag": 188
  7063. - },
  7064. - {
  7065. - "_id": 65,
  7066. - "fecha_creacion": "2016-03-16T15:50:28.753Z",
  7067. - "fecha_modificacion": "2016-03-16T15:50:28.753Z",
  7068. - "fk_persona": 248,
  7069. - "fk_tag": 189
  7070. - },
  7071. - {
  7072. - "_id": 63,
  7073. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  7074. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  7075. - "fk_persona": 250,
  7076. - "fk_tag": 190
  7077. - }
  7078. - ]
  7079. - }
  7080. -
  7081. -Ordena las relaciones entre un tag y una persona descendentemente en base a un campo del modelo
  7082. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  7083. -
  7084. -**URL**
  7085. -::
  7086. -
  7087. - /tagsPersonas?ordenarPor=valor1&orden=true
  7088. -
  7089. -**Parámetros usados**
  7090. -
  7091. -============ =================
  7092. -**Nombre** **Valor enviado**
  7093. -============ =================
  7094. -`ordenarPor` fk_persona
  7095. -`orden` true
  7096. -============ =================
  7097. -
  7098. -**Ejemplo:**
  7099. -::
  7100. -
  7101. - /tagsPersonas?ordenarPor=fk_persona&orden=true
  7102. -
  7103. -**Respuesta:**
  7104. -
  7105. -.. code:: json
  7106. -
  7107. - {
  7108. - "count":3,"rows":
  7109. - [
  7110. - {
  7111. - "_id": 63,
  7112. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  7113. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  7114. - "fk_persona": 250,
  7115. - "fk_tag": 190
  7116. - },
  7117. - {
  7118. - "_id": 65,
  7119. - "fecha_creacion": "2016-03-16T15:50:28.753Z",
  7120. - "fecha_modificacion": "2016-03-16T15:50:28.753Z",
  7121. - "fk_persona": 248,
  7122. - "fk_tag": 189
  7123. - },
  7124. - {
  7125. - "_id": 64,
  7126. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  7127. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  7128. - "fk_persona": 247,
  7129. - "fk_tag": 188
  7130. - }
  7131. - ]
  7132. - }
  7133. -
  7134. -Muestra los detalles de Personas y Tags
  7135. -'''''''''''''''''''''''''''''''''''''''''
  7136. -
  7137. -**URL**
  7138. -::
  7139. -
  7140. - /tagsPersonas?incluye=%7B%22entidad%22:%22valor1%22%7D&incluye=%7B%22entidad%22:%22valor2%22%7D
  7141. -
  7142. -**Parámetros usados**
  7143. -
  7144. -============ ===========================================
  7145. -**Nombre** **Valor enviado**
  7146. -============ ===========================================
  7147. -`incluye` ::
  7148. -
  7149. - [{"entidad":"Persona"},{"entidad":"Tag"}]
  7150. -============ ===========================================
  7151. -
  7152. -**Ejemplo:**
  7153. -::
  7154. -
  7155. - /tagsPersonas?incluye=%7B%22entidad%22:%22Persona%22%7D&incluye=%7B%22entidad%22:%22Tag%22%7D
  7156. -
  7157. -**Respuesta:**
  7158. -
  7159. -.. code:: json
  7160. -
  7161. - {
  7162. - "count":3,"rows":
  7163. - [
  7164. - {
  7165. - "_id": 63,
  7166. - "fecha_creacion": "2016-01-16T15:50:28.738Z",
  7167. - "fecha_modificacion": "2016-01-16T15:50:28.738Z",
  7168. - "fk_persona": 250,
  7169. - "fk_tag": 190,
  7170. - "Persona":
  7171. - {
  7172. - "_id": 250,
  7173. - "nombres": "Juan",
  7174. - "apellidos": "Garzofino Blanco",
  7175. - "ci": 172348,
  7176. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  7177. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  7178. - },
  7179. - "Tag":
  7180. - {
  7181. - "_id": 190,
  7182. - "nombre": "Java",
  7183. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  7184. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  7185. - }
  7186. - },
  7187. - {
  7188. - "_id": 64,
  7189. - "fecha_creacion": "2016-03-03T15:50:28.752Z",
  7190. - "fecha_modificacion": "2016-03-03T15:50:28.752Z",
  7191. - "fk_persona": 247,
  7192. - "fk_tag": 188,
  7193. - "Persona":
  7194. - {
  7195. - "_id": 247,
  7196. - "nombres": "Daniel Hugo",
  7197. - "apellidos": "Estrada Jimenez",
  7198. - "ci": 27238,
  7199. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  7200. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  7201. - },
  7202. - "Tag":
  7203. - {
  7204. - "_id": 188,
  7205. - "nombre": "Python",
  7206. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  7207. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  7208. - }
  7209. - },
  7210. - {
  7211. - "_id": 65,
  7212. - "fecha_creacion": "2016-03-16T15:50:28.753Z",
  7213. - "fecha_modificacion": "2016-03-16T15:50:28.753Z",
  7214. - "fk_persona": 248,
  7215. - "fk_tag": 189,
  7216. - "Persona":
  7217. - {
  7218. - "_id": 248,
  7219. - "nombres": "Alba",
  7220. - "apellidos": "Guzman Arias",
  7221. - "ci": 4542,
  7222. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  7223. - "fecha_modificacion": "2016-01-14T22:52:31.554Z"
  7224. - },
  7225. - "Tag":
  7226. - {
  7227. - "_id": 189,
  7228. - "nombre": "PHP",
  7229. - "fecha_creacion": "2016-03-16T15:50:28.629Z",
  7230. - "fecha_modificacion": "2016-03-16T15:50:28.629Z"
  7231. - }
  7232. - }
  7233. - ]
  7234. - }
  7235. -
  7236. -Respuesta de error
  7237. -``````````````````
  7238. -
  7239. -**Código:** 500
  7240. -
  7241. -**Contenido:**
  7242. -
  7243. -.. code:: json
  7244. -
  7245. - {
  7246. - "error":"Ocurrio un problema inesperado en el servidor"
  7247. - }
  7248. -
  7249. -Observaciones
  7250. -`````````````
  7251. -- Cuando no existen datos almacenados en la base de datos retorna un array vacio
  7252. -- El parámetro 'orden' depende de 'ordenarPor'
  7253. -- El parámetro 'pagina' muestra 15 relaciones entre Tag y persona por defecto
  7254. -- Solo se puede hacer "incluye" con las entidades "tag" y "persona"
  7255. -
  7256. -----
  7257. -
  7258. -Crear una relacion entre un tag y una persona
  7259. ------------------------------------------------
  7260. -
  7261. -URL
  7262. -```
  7263. -::
  7264. -
  7265. - /tagsPersonas
  7266. -
  7267. -Método
  7268. -``````
  7269. -``POST``
  7270. -
  7271. -Parámetros del body
  7272. -```````````````````
  7273. -**Ejemplo:**
  7274. -
  7275. -.. code:: json
  7276. -
  7277. - {
  7278. - "fk_persona":246,
  7279. - "fk_tag":187
  7280. - }
  7281. -
  7282. -Respuesta correcta
  7283. -``````````````````
  7284. -
  7285. -**Código:** 201
  7286. -
  7287. -**Ejemplo:**
  7288. -
  7289. -.. code:: json
  7290. -
  7291. - {
  7292. - "_id": 68,
  7293. - "fk_persona": 246,
  7294. - "fk_tag": 187,
  7295. - "fecha_modificacion": "2016-03-16T19:01:06.559Z",
  7296. - "fecha_creacion": "2016-03-16T19:01:06.559Z"
  7297. - }
  7298. -
  7299. -Respuesta de error
  7300. -``````````````````
  7301. -
  7302. -**Código:** 500
  7303. -
  7304. -**Contenido:**
  7305. -
  7306. -.. code:: json
  7307. -
  7308. - {
  7309. - "name": "SequelizeForeignKeyConstraintError",
  7310. - "message": "inserción o actualización en la tabla «tag_persona» viola la llave foránea «tag_persona_fk_tag_fkey»"
  7311. - }
  7312. -
  7313. -----
  7314. -
  7315. -Mostrar una relacion entre un tag y una persona
  7316. --------------------------------------------------
  7317. -
  7318. -URL
  7319. -```
  7320. -::
  7321. -
  7322. - /tagsPersonas/:id
  7323. -
  7324. -Método
  7325. -``````
  7326. -``GET``
  7327. -
  7328. -Parámetros de la URL
  7329. -````````````````````
  7330. -
  7331. -**Parámetro requerido:**
  7332. -
  7333. -============ ============== ================================================
  7334. -**Nombre** **Tipo** **Descripción**
  7335. -============ ============== ================================================
  7336. -`id` Integer Identificador único del registro en la entidad.
  7337. -============ ============== ================================================
  7338. -
  7339. -**Ejemplo:**
  7340. -::
  7341. -
  7342. - id=63
  7343. -
  7344. -Respuesta correcta
  7345. -``````````````````
  7346. -
  7347. -**Código:** 200
  7348. -
  7349. -**Contenido:**
  7350. -
  7351. -.. code:: json
  7352. -
  7353. - {
  7354. - "_id": 63,
  7355. - "fecha_creacion": "2016-03-16T15:50:28.738Z",
  7356. - "fecha_modificacion": "2016-03-16T15:50:28.738Z",
  7357. - "fk_persona": 246,
  7358. - "fk_tag": 187
  7359. - }
  7360. -
  7361. -Respuesta de error
  7362. -``````````````````
  7363. -
  7364. -**Código:** 404
  7365. -
  7366. -**Contenido:**
  7367. -
  7368. -.. code:: json
  7369. -
  7370. - {
  7371. - "message": "Entidad no encontrada"
  7372. - }
  7373. -
  7374. -----
  7375. -
  7376. -Editar una relacion entre tag y persona
  7377. -------------------------------------------
  7378. -
  7379. -URL
  7380. -```
  7381. -::
  7382. -
  7383. - /tagsPersonas/:id
  7384. -
  7385. -Método
  7386. -``````
  7387. -``PUT``
  7388. -
  7389. -Parámetros de la URL
  7390. -````````````````````
  7391. -
  7392. -**Parámetro requerido:**
  7393. -
  7394. -============ ============== ================================================
  7395. -**Nombre** **Tipo** **Descripción**
  7396. -============ ============== ================================================
  7397. -`id` Integer Identificador único del registro en la entidad.
  7398. -============ ============== ================================================
  7399. -
  7400. -**Ejemplo:**
  7401. -::
  7402. -
  7403. - id=63
  7404. -
  7405. -Parámetros del body
  7406. -```````````````````
  7407. -**Ejemplo:**
  7408. -
  7409. -.. code:: json
  7410. -
  7411. - {
  7412. - "fk_persona":246,
  7413. - "fk_tag":188
  7414. - }
  7415. -
  7416. -Respuesta correcta
  7417. -``````````````````
  7418. -
  7419. -**Código:** 200
  7420. -
  7421. -**Ejemplo:**
  7422. -
  7423. -.. code:: json
  7424. -
  7425. - {
  7426. - "_id": 63,
  7427. - "fecha_creacion": "2016-03-16T15:50:28.738Z",
  7428. - "fecha_modificacion": "2016-03-16T19:07:58.475Z",
  7429. - "fk_persona": 246,
  7430. - "fk_tag": 188
  7431. - }
  7432. -
  7433. -Respuesta de error
  7434. -``````````````````
  7435. -
  7436. -**Código:** 404
  7437. -
  7438. -**Contenido:**
  7439. -
  7440. -.. code:: json
  7441. -
  7442. - {
  7443. - "message": "Entidad no encontrada"
  7444. - }
  7445. -
  7446. -----
  7447. -
  7448. -Eliminar una relacion entre un tag y una persona
  7449. ---------------------------------------------------
  7450. -
  7451. -URL
  7452. -```
  7453. -::
  7454. -
  7455. - /tagsPersonas/:id
  7456. -
  7457. -Método
  7458. -``````
  7459. -``DELETE``
  7460. -
  7461. -Parámetros de la URL
  7462. -````````````````````
  7463. -
  7464. -**Parámetro requerido:**
  7465. -
  7466. -============ ============== ================================================
  7467. -**Nombre** **Tipo** **Descripción**
  7468. -============ ============== ================================================
  7469. -`id` Integer Identificador único del registro en la entidad.
  7470. -============ ============== ================================================
  7471. -
  7472. -**Ejemplo:**
  7473. -::
  7474. -
  7475. - id=63
  7476. -
  7477. -Respuesta correcta
  7478. -``````````````````
  7479. -
  7480. -**Código:** 204
  7481. -
  7482. -Respuesta de error
  7483. -``````````````````
  7484. -
  7485. -**Código:** 404
  7486. -
  7487. -**Contenido:**
  7488. -
  7489. -.. code:: json
  7490. -
  7491. - {
  7492. - "message": "Entidad no encontrada"
  7493. - }
  7494. -
  7495. -----
  7496. -
  7497. -Obtener todos los tags de una persona
  7498. ----------------------------------------
  7499. -
  7500. -URL
  7501. -```
  7502. -::
  7503. -
  7504. - /tagsPersonas/persona/:id
  7505. -
  7506. -Método
  7507. -``````
  7508. -``GET``
  7509. -
  7510. -Parámetros de la URL
  7511. -````````````````````
  7512. -
  7513. -**Parámetro requerido:**
  7514. -
  7515. -============ ============== ================================================
  7516. -**Nombre** **Tipo** **Descripción**
  7517. -============ ============== ================================================
  7518. -`id` Integer Identificador único del registro en la entidad.
  7519. -============ ============== ================================================
  7520. -
  7521. -**Ejemplo:**
  7522. -::
  7523. -
  7524. - id=83
  7525. -
  7526. -Respuesta correcta
  7527. -``````````````````
  7528. -
  7529. -**Código:** 200
  7530. -
  7531. -**Contenido:**
  7532. -
  7533. -.. code:: json
  7534. -
  7535. - [
  7536. - {
  7537. - "_id": 188,
  7538. - "nombre": "tag 2",
  7539. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  7540. - "fecha_modificacion": "2016-03-16T15:50:28.628Z",
  7541. - "TagPersona": {
  7542. - "_id": 64,
  7543. - "fecha_creacion": "2016-03-16T15:50:28.752Z",
  7544. - "fecha_modificacion": "2016-03-16T15:50:28.752Z",
  7545. - "fk_persona": 247,
  7546. - "fk_tag": 188
  7547. - }
  7548. - },
  7549. - {
  7550. - "_id": 189,
  7551. - "nombre": "tag 4",
  7552. - "fecha_creacion": "2016-03-16T15:50:28.628Z",
  7553. - "fecha_modificacion": "2016-03-16T15:50:28.628Z",
  7554. - "TagPersona": {
  7555. - "_id": 65,
  7556. - "fecha_creacion": "2016-03-16T15:50:28.752Z",
  7557. - "fecha_modificacion": "2016-03-16T15:50:28.752Z",
  7558. - "fk_persona": 247,
  7559. - "fk_tag": 189
  7560. - }
  7561. - }
  7562. - ]
  7563. -
  7564. -Respuesta de error
  7565. -``````````````````
  7566. -
  7567. -**Código:** 404
  7568. -
  7569. -**Contenido:**
  7570. -
  7571. -.. code:: json
  7572. -
  7573. - {
  7574. - "message": "Entidad no encontrada"
  7575. - }
  7576. -
  7577. -----
  7578. -
  7579. -Obtener todos los personas de un Tag
  7580. ----------------------------------------
  7581. -
  7582. -URL
  7583. -```
  7584. -::
  7585. -
  7586. - /tagsPersonas/tag/:id
  7587. -
  7588. -Método
  7589. -``````
  7590. -``GET``
  7591. -
  7592. -Parámetros de la URL
  7593. -````````````````````
  7594. -
  7595. -**Parámetro requerido:**
  7596. -
  7597. -============ ============== ================================================
  7598. -**Nombre** **Tipo** **Descripción**
  7599. -============ ============== ================================================
  7600. -`id` Integer Identificador único del registro en la entidad.
  7601. -============ ============== ================================================
  7602. -
  7603. -**Ejemplo:**
  7604. -::
  7605. -
  7606. - id=194
  7607. -
  7608. -Respuesta correcta
  7609. -``````````````````
  7610. -
  7611. -**Código:** 200
  7612. -
  7613. -**Contenido:**
  7614. -
  7615. -.. code:: json
  7616. -
  7617. - [
  7618. - {
  7619. - "_id": 251,
  7620. - "nombres": "Juan Carlos",
  7621. - "apellidos": "Perez Gomez",
  7622. - "ci": "6867562",
  7623. - "createdAt": "2016-03-16T19:18:07.801Z",
  7624. - "updatedAt": "2016-03-16T19:18:07.801Z",
  7625. - "TagPersona": {
  7626. - "_id": 70,
  7627. - "fecha_creacion": "2016-03-16T19:18:08.004Z",
  7628. - "fecha_modificacion": "2016-03-16T19:18:08.004Z",
  7629. - "fk_persona": 251,
  7630. - "fk_tag": 194
  7631. - }
  7632. - },
  7633. - {
  7634. - "_id": 252,
  7635. - "nombres": "Ana Maria",
  7636. - "apellidos": "Suarez",
  7637. - "ci": "6867122",
  7638. - "createdAt": "2016-03-16T19:18:07.801Z",
  7639. - "updatedAt": "2016-03-16T19:18:07.801Z",
  7640. - "TagPersona": {
  7641. - "_id": 71,
  7642. - "fecha_creacion": "2016-03-16T19:18:08.004Z",
  7643. - "fecha_modificacion": "2016-03-16T19:18:08.004Z",
  7644. - "fk_persona": 252,
  7645. - "fk_tag": 194
  7646. - }
  7647. - }
  7648. - ]
  7649. -
  7650. -Respuesta de error
  7651. -``````````````````
  7652. -
  7653. -**Código:** 404
  7654. -
  7655. -**Contenido:**
  7656. -
  7657. -.. code:: json
  7658. -
  7659. - {
  7660. - "message": "Entidad no encontrada"
  7661. - }
  7662. +Tag Persona
  7663. +====================
  7664. +
  7665. +Formato URL
  7666. +------------------------
  7667. ++-----------------+-------------------------+
  7668. +|**Método HTTP** |**Significado** |
  7669. ++=================+=========================+
  7670. +|`GET` | Obtiene un recurso |
  7671. ++-----------------+-------------------------+
  7672. +|`POST` | Crea un recurso |
  7673. ++-----------------+-------------------------+
  7674. +|`PUT` | Actualiza un recurso |
  7675. ++-----------------+-------------------------+
  7676. +|`DELETE` | Borra un recurso |
  7677. ++-----------------+-------------------------+
  7678. +
  7679. +Ejemplo
  7680. +''''''''''''
  7681. +
  7682. +**Contenido Body**
  7683. +
  7684. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  7685. +
  7686. +.. code:: json
  7687. +
  7688. + {
  7689. + "fecha_creacion": "2016-04-27T20:58:20.042Z",
  7690. + "fecha_modificacion": "2016-04-27T20:58:20.042Z",
  7691. + "fk_persona": 1202, // Persona: Jesus Adrian Romero
  7692. + "fk_tag": 1 // Tag: javascript
  7693. + }
  7694. +
  7695. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  7696. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  7697. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  7698. +| /tagsPersonas | Obtiene el listado de todos los Tag-Persona | Crea un registro de Tag-Persona | | |
  7699. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  7700. +| /tagsPersonas/:id | Obtiene el Tag-Persona identificado como :id | | Actualiza registro :id de Tag-Persona | Elimina registro :id de Tag-Persona |
  7701. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  7702. +
  7703. +Respuestas
  7704. +----------
  7705. +
  7706. ++------------------+----------------------------------------------------------------------------------------------+
  7707. +| **Código HTTP** | **Descripción** |
  7708. ++==================+==============================================================================================+
  7709. +| `200` | Ok |
  7710. ++------------------+----------------------------------------------------------------------------------------------+
  7711. +| `201` | Creado |
  7712. ++------------------+----------------------------------------------------------------------------------------------+
  7713. +| `400` | Parámetros incorrectos en la entrada |
  7714. ++------------------+----------------------------------------------------------------------------------------------+
  7715. +| `401` | Token de acceso expirado o invalido |
  7716. ++------------------+----------------------------------------------------------------------------------------------+
  7717. +| `404` | Recurso no encontrado |
  7718. ++------------------+----------------------------------------------------------------------------------------------+
  7719. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  7720. ++------------------+----------------------------------------------------------------------------------------------+
  7721. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  7722. ++------------------+----------------------------------------------------------------------------------------------+
  7723. +| `500` | Error interno del servidor |
  7724. ++------------------+----------------------------------------------------------------------------------------------+
  7725. diff --git a/docs/test/test.rst b/docs/test/test.rst
  7726. deleted file mode 100644
  7727. index 6ba0462..0000000
  7728. --- a/docs/test/test.rst
  7729. +++ /dev/null
  7730. @@ -1,96 +0,0 @@
  7731. -Guia de Testing
  7732. -===============
  7733. -
  7734. -Para la elaboración de los Test se utlizo `Mocha`_
  7735. -
  7736. -Para ejecutar los test, se escribe en la terminal el comando ``npm test`` dentro de la ruta donde está el proyecto.
  7737. -
  7738. -Los procesos de cada modulo se encuentra en ``[entidad].controller.js``.
  7739. -
  7740. -Los test de cada proceso se encuentra en ``[entidad].integration.js`` .
  7741. -
  7742. -Primeramente se verifica si existe las rutas de cada entidad, todas esas verificaciones esta guardadas en ``index.spec.js`` de cada entidad.
  7743. -
  7744. -Tome como ejemplo la creación de un postulante.
  7745. -
  7746. -*Extraido de* ``server/api/postulantes/index.spec.js``
  7747. -
  7748. -.. code:: javascript
  7749. -
  7750. - describe('POST /api/postulantes', function() {
  7751. - it('Debe apuntar a la ruta postulante.controller.create', function() {
  7752. - expect(routerStub.post
  7753. - .withArgs('/', 'postulanteCtrl.create')
  7754. - ).to.have.been.calledOnce;
  7755. - });
  7756. - });
  7757. -
  7758. -Luego se procede a hacer los test en este ejemplo verificara si creo un postulante:
  7759. -
  7760. -*Extraido de* ``server/api/postulacion/postulante.integration.js``
  7761. -
  7762. -.. code:: javascript
  7763. -
  7764. - describe('POST /api/postulantes', function() {
  7765. - beforeEach(function(done) {
  7766. - request(app)
  7767. - .post('/api/postulantes')
  7768. - .send({
  7769. - nombres: 'Alvaro',
  7770. - apellidos: 'Alvarez Alvarado',
  7771. - ci: '123456 LP',
  7772. - sexo: true
  7773. - })
  7774. - .expect(201)
  7775. - .expect('Content-Type', /json/)
  7776. - .end((err, res) => {
  7777. - if (err) {
  7778. - return done(err);
  7779. - }
  7780. - nuevoPostulante = res.body;
  7781. - done();
  7782. - });
  7783. - });
  7784. -
  7785. - it('Debe responder con una nueva creacion de postulante', function() {
  7786. - expect(nuevoPostulante.nombres).to.equal('Alvaro');
  7787. - expect(nuevoPostulante.apellidos).to.equal('Alvarez Alvarado');
  7788. - expect(nuevoPostulante.ci).to.equal('123456 LP');
  7789. - expect(nuevoPostulante.sexo).to.equal(true);
  7790. - });
  7791. - });
  7792. -
  7793. -En la función ``beforeEach()`` se envia los datos del postulante a la ruta ``/api/postulantes`` y nos devuelve un json en ``res.body``.
  7794. -
  7795. -En la función ``it()`` se compara si los datos recibidos son iguales a los enviados.
  7796. -
  7797. -En algunos casos particulares como ser "Obtener las postulaciones de un determinado postulante".
  7798. -
  7799. -.. code:: javascript
  7800. -
  7801. - describe('GET /api/postulaciones/postulante/:id',function(){
  7802. - var postulaciones;
  7803. - beforeEach(function(done){
  7804. - request(app)
  7805. - .get('/api/postulaciones/postulante/'+nuevoPostulante._id)
  7806. - .expect(200)
  7807. - .expect('Content-Type', /json/)
  7808. - .end((err, res) => {
  7809. - if (err) {
  7810. - return done(err);
  7811. - }
  7812. - postulaciones = res.body;
  7813. - done();
  7814. - })
  7815. - })
  7816. - it('responder con 200 si existe los cargos',function(){
  7817. - expect(postulaciones[0]._id).to.equal(nuevoCargo._id);
  7818. - expect(postulaciones[0].nombre).to.equal(nuevoCargo.nombre);
  7819. - expect(postulaciones[0].Postulacion._id).to.equal(nuevoPostulacion._id);
  7820. - });
  7821. - })
  7822. -
  7823. -La tabla "postulacion" esta relacionada con las tablas "postulante" y "cargo", era necesario tener los datos del postulante y cargo en la base de datos. Previamente se enviaron los datos del postulante y cargo.
  7824. -
  7825. -
  7826. -.. _Mocha: https://mochajs.org/
  7827. diff --git a/docs/tipoDato/tipoDato.rst b/docs/tipoDato/tipoDato.rst
  7828. deleted file mode 100644
  7829. index 65b7fab..0000000
  7830. --- a/docs/tipoDato/tipoDato.rst
  7831. +++ /dev/null
  7832. @@ -1,699 +0,0 @@
  7833. -Tipo de Dato
  7834. -============
  7835. -
  7836. -Mostrar todos los Tipos de Dato
  7837. --------------------------------
  7838. -
  7839. -URL
  7840. -```
  7841. -::
  7842. -
  7843. - /tiposDato
  7844. -
  7845. -Método
  7846. -``````
  7847. -``GET``
  7848. -
  7849. -Respuesta correcta
  7850. -``````````````````
  7851. -
  7852. -**Código:** 200
  7853. -
  7854. -**Contenido:**
  7855. -
  7856. -.. code:: json
  7857. -
  7858. - {
  7859. - "count":3,"rows":
  7860. - [
  7861. - {
  7862. - "propiedad": "EMAIL",
  7863. - "nombre": "correo electronico",
  7864. - "createdAt": "2016-03-14T22:52:31.554Z",
  7865. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7866. - "deletedAt": null
  7867. - },
  7868. - {
  7869. - "propiedad": "TEL",
  7870. - "nombre": "Telefono",
  7871. - "createdAt": "2016-03-14T22:52:31.554Z",
  7872. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7873. - "deletedAt": null
  7874. - },
  7875. - {
  7876. - "propiedad": "WEB",
  7877. - "nombre": "Pagina Web",
  7878. - "createdAt": "2016-03-14T22:52:31.554Z",
  7879. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7880. - "deletedAt": null
  7881. - }
  7882. - ]
  7883. - }
  7884. -
  7885. -Parámetros opcionales de la URL
  7886. -```````````````````````````````
  7887. -Tabla de parámetros
  7888. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  7889. -+-+-----------+------------------+---------------------------------------------------------------------+
  7890. -|**Nombre** |**Tipo** |**Descripción** |
  7891. -+=+===========+==================+=====================================================================+
  7892. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  7893. -+-+-----------+------------------+---------------------------------------------------------------------+
  7894. -|`pagina` | Integer |El número de página a mostrar. |
  7895. -+-+-----------+------------------+---------------------------------------------------------------------+
  7896. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  7897. -+-+-----------+------------------+---------------------------------------------------------------------+
  7898. -|`orden` | Boolean |TRUE para un orden descendente. |
  7899. -+-+-----------+------------------+---------------------------------------------------------------------+
  7900. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  7901. -+-+-----------+------------------+---------------------------------------------------------------------+
  7902. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  7903. -+-+-----------+------------------+---------------------------------------------------------------------+
  7904. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  7905. -+-+-----------+------------------+---------------------------------------------------------------------+
  7906. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  7907. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  7908. -| | |`buscar` definido anteriormente) |
  7909. -+-+-----------+------------------+---------------------------------------------------------------------+
  7910. -| |`entidad` | String |El nombre de la entidad. |
  7911. -+-+-----------+------------------+---------------------------------------------------------------------+
  7912. -
  7913. -Muestra una determinada cantidad de tipos de dato
  7914. -'''''''''''''''''''''''''''''''''''''''''''''''''
  7915. -
  7916. -**URL**
  7917. -::
  7918. -
  7919. - /tiposDato?elementos=valor
  7920. -
  7921. -**Parámetros usados**
  7922. -
  7923. -============ =====================
  7924. -**Nombre** **Valor enviado**
  7925. -============ =====================
  7926. -`elementos` 2
  7927. -============ =====================
  7928. -
  7929. -**Ejemplo:**
  7930. -::
  7931. -
  7932. - /tiposDato?elementos=2
  7933. -
  7934. -**Respuesta:**
  7935. -
  7936. -.. code:: json
  7937. -
  7938. - {
  7939. - "count":3,"rows":
  7940. - [
  7941. - {
  7942. - "propiedad": "EMAIL",
  7943. - "nombre": "correo electronico",
  7944. - "createdAt": "2016-03-14T22:52:31.554Z",
  7945. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7946. - "deletedAt": null
  7947. - },
  7948. - {
  7949. - "propiedad": "TEL",
  7950. - "nombre": "Telefono",
  7951. - "createdAt": "2016-03-14T22:52:31.554Z",
  7952. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7953. - "deletedAt": null
  7954. - }
  7955. - ]
  7956. - }
  7957. -
  7958. -Muestra los tipos de dato en una determinada página
  7959. -'''''''''''''''''''''''''''''''''''''''''''''''''''
  7960. -
  7961. -**URL**
  7962. -::
  7963. -
  7964. - /tiposDato?pagina=valor
  7965. -
  7966. -**Parámetros usados**
  7967. -
  7968. -============ =====================
  7969. -**Nombre** **Valor enviado**
  7970. -============ =====================
  7971. -`pagina` 1
  7972. -============ =====================
  7973. -
  7974. -**Ejemplo:**
  7975. -::
  7976. -
  7977. - /tiposDato?pagina=1
  7978. -
  7979. -**Respuesta:**
  7980. -
  7981. -.. code:: json
  7982. -
  7983. - {
  7984. - "count":3,"rows":
  7985. - [
  7986. - {
  7987. - "propiedad": "EMAIL",
  7988. - "nombre": "correo electronico",
  7989. - "createdAt": "2016-03-14T22:52:31.554Z",
  7990. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7991. - "deletedAt": null
  7992. - },
  7993. - {
  7994. - "propiedad": "TEL",
  7995. - "nombre": "Telefono",
  7996. - "createdAt": "2016-03-14T22:52:31.554Z",
  7997. - "updatedAt": "2016-03-14T22:52:31.554Z",
  7998. - "deletedAt": null
  7999. - },
  8000. - {
  8001. - "propiedad": "WEB",
  8002. - "nombre": "Pagina Web",
  8003. - "createdAt": "2016-03-14T22:52:31.554Z",
  8004. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8005. - "deletedAt": null
  8006. - }
  8007. - ]
  8008. - }
  8009. -
  8010. -Ordena los tipos de dato ascendentemente en base a un campo del modelo
  8011. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8012. -
  8013. -**URL**
  8014. -::
  8015. -
  8016. - /tiposDato?ordenarPor=valor
  8017. -
  8018. -**Parámetros usados**
  8019. -
  8020. -============ =====================
  8021. -**Nombre** **Valor enviado**
  8022. -============ =====================
  8023. -`ordenarPor` nombre
  8024. -============ =====================
  8025. -
  8026. -**Ejemplo:**
  8027. -::
  8028. -
  8029. - /tiposDato?ordenarPor=nombre
  8030. -
  8031. -**Respuesta:**
  8032. -
  8033. -.. code:: json
  8034. -
  8035. - {
  8036. - "count":3,"rows":
  8037. - [
  8038. - {
  8039. - "propiedad": "EMAIL",
  8040. - "nombre": "correo electronico",
  8041. - "createdAt": "2016-03-14T22:52:31.554Z",
  8042. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8043. - "deletedAt": null
  8044. - },
  8045. - {
  8046. - "propiedad": "WEB",
  8047. - "nombre": "Pagina Web",
  8048. - "createdAt": "2016-03-14T22:52:31.554Z",
  8049. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8050. - "deletedAt": null
  8051. - },
  8052. - {
  8053. - "propiedad": "TEL",
  8054. - "nombre": "Telefono",
  8055. - "createdAt": "2016-03-14T22:52:31.554Z",
  8056. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8057. - "deletedAt": null
  8058. - }
  8059. - ]
  8060. - }
  8061. -
  8062. -Ordena los tipos de dato descendentemente en base a un campo del modelo
  8063. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8064. -
  8065. -**URL**
  8066. -::
  8067. -
  8068. - /tiposDato?ordenarPor=valor1&orden=true
  8069. -
  8070. -**Parámetros usados**
  8071. -
  8072. -============ =================
  8073. -**Nombre** **Valor enviado**
  8074. -============ =================
  8075. -`ordenarPor` nombre
  8076. -`orden` true
  8077. -============ =================
  8078. -
  8079. -**Ejemplo:**
  8080. -::
  8081. -
  8082. - /tiposDato?ordenarPor=nombre&orden=true
  8083. -
  8084. -**Respuesta:**
  8085. -
  8086. -.. code:: json
  8087. -
  8088. - {
  8089. - "count":3,"rows":
  8090. - [
  8091. - {
  8092. - "propiedad": "TEL",
  8093. - "nombre": "Telefono",
  8094. - "createdAt": "2016-03-14T22:52:31.554Z",
  8095. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8096. - "deletedAt": null
  8097. - },
  8098. - {
  8099. - "propiedad": "WEB",
  8100. - "nombre": "Pagina Web",
  8101. - "createdAt": "2016-03-14T22:52:31.554Z",
  8102. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8103. - "deletedAt": null
  8104. - },
  8105. - {
  8106. - "propiedad": "EMAIL",
  8107. - "nombre": "correo electronico",
  8108. - "createdAt": "2016-03-14T22:52:31.554Z",
  8109. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8110. - "deletedAt": null
  8111. - }
  8112. - ]
  8113. - }
  8114. -
  8115. -Busca los Tipos De Datos que contengas las palabras "TEL" y "Telefono" en los campos "propiedad" y "nombre"
  8116. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8117. -
  8118. -**URL**
  8119. -::
  8120. -
  8121. - /tiposDato?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  8122. -
  8123. -**Parámetros usados**
  8124. -
  8125. -============ ===========================================
  8126. -**Nombre** **Valor enviado**
  8127. -============ ===========================================
  8128. -`buscar` ::
  8129. -
  8130. - [{"en":"propiedad","palabra":"Telefono"}]
  8131. -============ ===========================================
  8132. -
  8133. -**Ejemplo:**
  8134. -::
  8135. -
  8136. - /tiposDato?buscar=%7B%22en%22:%22propiedad%22,%22palabra%22:%22Telefono%22%7D
  8137. -
  8138. -**Respuesta:**
  8139. -
  8140. -.. code:: json
  8141. -
  8142. - {
  8143. - "count":3,"rows":
  8144. - [
  8145. - {
  8146. - "propiedad": "TEL",
  8147. - "nombre": "Telefono",
  8148. - "createdAt": "2016-03-14T22:52:31.554Z",
  8149. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8150. - "deletedAt": null
  8151. - }
  8152. - ]
  8153. - }
  8154. -
  8155. -Muestra los postulantes de tienen la propiedad "EMAIL"
  8156. -''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8157. -
  8158. -**URL**
  8159. -::
  8160. -
  8161. - /tiposDato?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D&incluye=%7B%22entidad%22:%22valor3%22%7D
  8162. -
  8163. -**Parámetros usados**
  8164. -
  8165. -============ ===========================================
  8166. -**Nombre** **Valor enviado**
  8167. -============ ===========================================
  8168. -`buscar` ::
  8169. -
  8170. - [{"en":"propiedad","palabra":"email"}]
  8171. -
  8172. -`incluye` ::
  8173. -
  8174. - [{"entidad":"persona"}]
  8175. -============ ===========================================
  8176. -
  8177. -**Ejemplo:**
  8178. -::
  8179. -
  8180. - /tiposDato?buscar=%7B%22en%22:%22propiedad%22,%22palabra%22:%22email%22%7D&incluye=%7B%22entidad%22:%22persona%22%7D
  8181. -
  8182. -**Respuesta:**
  8183. -
  8184. -.. code:: json
  8185. -
  8186. - {
  8187. - "count":3,"rows":
  8188. - [
  8189. - {
  8190. - "propiedad": "EMAIL",
  8191. - "nombre": "correo electronico",
  8192. - "createdAt": "2016-03-14T22:52:31.554Z",
  8193. - "updatedAt": "2016-03-14T22:52:31.554Z",,
  8194. - "deletedAt": null,
  8195. - "Personas":
  8196. - [
  8197. - {
  8198. - "_id": 50,
  8199. - "nombres": "Fabio",
  8200. - "apellidos": "Gonzales Lima",
  8201. - "ci": 37234258,
  8202. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  8203. - "fecha_modificacion": "2016-01-14T22:52:31.554Z",
  8204. - "Datos":
  8205. - {
  8206. - "_id": 2,
  8207. - "valor": "fabio@gmail.com",
  8208. - "createdAt": "2016-02-14T22:03:48.216Z",
  8209. - "updatedAt": "2016-02-14T22:03:48.216Z",
  8210. - "fk_persona": 50,
  8211. - "propiedad": "EMAIL"
  8212. - }
  8213. - },
  8214. - {
  8215. - "_id": 60,
  8216. - "nombres": "Hugo",
  8217. - "apellidos": "Molina Mendez",
  8218. - "ci": 39398,
  8219. - "fecha_creacion": "2016-01-14T22:52:31.554Z",
  8220. - "fecha_modificacion": "2016-01-14T22:52:31.554Z",
  8221. - "Datos":
  8222. - {
  8223. - "_id": 2,
  8224. - "valor": "hmm@gmail.com",
  8225. - "createdAt": "2016-02-14T22:03:48.216Z",
  8226. - "updatedAt": "2016-02-14T22:03:48.216Z",
  8227. - "fk_persona": 60,
  8228. - "propiedad": "EMAIL"
  8229. - }
  8230. - }
  8231. - ]
  8232. - }
  8233. - ]
  8234. - }
  8235. -
  8236. -Respuesta de error
  8237. -``````````````````
  8238. -
  8239. -**Código:** 500
  8240. -
  8241. -**Contenido:**
  8242. -
  8243. -.. code:: json
  8244. -
  8245. - {
  8246. - "error":"Ocurrio un problema inesperado en el servidor"
  8247. - }
  8248. -
  8249. -Observaciones
  8250. -`````````````
  8251. -- Cuando no existen datos almacenados en la base de datos retorna un array vacio
  8252. -- El parámetro 'orden' depende de 'ordenarPor'
  8253. -- El parámetro 'pagina' muestra 15 tipos de dato por defecto
  8254. -
  8255. -----
  8256. -
  8257. -Crear un Tipo de Dato
  8258. ----------------------
  8259. -
  8260. -URL
  8261. -```
  8262. -::
  8263. -
  8264. - /tiposDato
  8265. -
  8266. -Método
  8267. -``````
  8268. -``POST``
  8269. -
  8270. -Parámetros del body
  8271. -```````````````````
  8272. -**Ejemplo:**
  8273. -
  8274. -.. code:: json
  8275. -
  8276. - {
  8277. - "propiedad": "WEB",
  8278. - "nombre": "Página"
  8279. - }
  8280. -
  8281. -Respuesta correcta
  8282. -``````````````````
  8283. -
  8284. -**Código:** 201
  8285. -
  8286. -**Contenido:**
  8287. -
  8288. -.. code:: json
  8289. -
  8290. - {
  8291. - "propiedad": "WEB",
  8292. - "nombre": "Página",
  8293. - "createdAt": "2016-03-14T22:52:31.554Z",
  8294. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8295. - "deletedAt": null
  8296. - }
  8297. -
  8298. -Respuesta de error
  8299. -``````````````````
  8300. -
  8301. -**Código:** 400
  8302. -
  8303. -**Contenido:**
  8304. -
  8305. -.. code:: json
  8306. -
  8307. - {
  8308. - "name": "SequelizeValidationError",
  8309. - "message": "Validation error: Ingrese nombre al Tipo de Dato.",
  8310. - "errors": [
  8311. - {
  8312. - "message": "Ingrese nombre al Tipo de Dato.",
  8313. - "type": "Validation error",
  8314. - "path": "nombre",
  8315. - "value": {},
  8316. - "__raw": {}
  8317. - }
  8318. - ]
  8319. - }
  8320. -
  8321. -**Código:** 409
  8322. -
  8323. -**Contenido:**
  8324. -
  8325. -.. code:: json
  8326. -
  8327. - {
  8328. - "name": "SequelizeUniqueConstraintError",
  8329. - "message": "El objeto ya existe",
  8330. - "errors": {}
  8331. - }
  8332. -
  8333. -----
  8334. -
  8335. -Mostrar un Tipo de dato
  8336. ------------------------
  8337. -
  8338. -URL
  8339. -```
  8340. -::
  8341. -
  8342. - /tiposDato/:id
  8343. -
  8344. -Método
  8345. -``````
  8346. -``GET``
  8347. -
  8348. -Parámetros de la URL
  8349. -````````````````````
  8350. -
  8351. -**Parámetro requerido:**
  8352. -
  8353. -============ ============== ================================================
  8354. -**Nombre** **Tipo** **Descripción**
  8355. -============ ============== ================================================
  8356. -`id` String Identificador único del registro en la entidad.
  8357. -============ ============== ================================================
  8358. -
  8359. -**Ejemplo:**
  8360. -::
  8361. -
  8362. - id=EMAIL
  8363. -
  8364. -Respuesta correcta
  8365. -``````````````````
  8366. -
  8367. -**Código:** 200
  8368. -
  8369. -**Contenido:**
  8370. -
  8371. -.. code:: json
  8372. -
  8373. - {
  8374. - "propiedad": "EMAIL",
  8375. - "nombre": "correo electronico",
  8376. - "createdAt": "2016-03-14T22:52:31.554Z",
  8377. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8378. - "deletedAt": null
  8379. - }
  8380. -
  8381. -Respuesta de error
  8382. -``````````````````
  8383. -
  8384. -**Código:** 404
  8385. -
  8386. -**Contenido:**
  8387. -
  8388. -.. code:: json
  8389. -
  8390. - {
  8391. - "message": "Entidad no encontrada"
  8392. - }
  8393. -
  8394. -----
  8395. -
  8396. -Editar un Tipo de Dato
  8397. -----------------------
  8398. -
  8399. -URL
  8400. -```
  8401. -::
  8402. -
  8403. - /tiposDato
  8404. -
  8405. -Método
  8406. -``````
  8407. -``PUT``
  8408. -
  8409. -Parámetros de la URL
  8410. -````````````````````
  8411. -
  8412. -**Parámetro requerido:**
  8413. -
  8414. -============ ============== ================================================
  8415. -**Nombre** **Tipo** **Descripción**
  8416. -============ ============== ================================================
  8417. -`id` String Identificador único del registro en la entidad.
  8418. -============ ============== ================================================
  8419. -
  8420. -**Ejemplo:**
  8421. -::
  8422. -
  8423. - id="WEB"
  8424. -
  8425. -Parámetros del body
  8426. -```````````````````
  8427. -**Ejemplo:**
  8428. -
  8429. -.. code:: json
  8430. -
  8431. - {
  8432. - "nombre": "Página web"
  8433. - }
  8434. -
  8435. -Respuesta correcta
  8436. -``````````````````
  8437. -
  8438. -**Código:** 200
  8439. -
  8440. -**Contenido:**
  8441. -
  8442. -.. code:: json
  8443. -
  8444. - {
  8445. - "propiedad": "WEB",
  8446. - "nombre": "Página web",
  8447. - "createdAt": "2016-03-14T22:52:31.554Z",
  8448. - "updatedAt": "2016-03-14T22:52:31.554Z",
  8449. - "deletedAt": null
  8450. - }
  8451. -
  8452. -**Repuesta de error**
  8453. -
  8454. -**Código:** 404
  8455. -
  8456. -**Contenido:**
  8457. -
  8458. -.. code:: json
  8459. -
  8460. - {
  8461. - "message": "Entidad no encontrada"
  8462. - }
  8463. -
  8464. -**Código:** 400
  8465. -
  8466. -**Contenido:**
  8467. -
  8468. -.. code:: json
  8469. -
  8470. - {
  8471. - "name": "SequelizeValidationError",
  8472. - "message": "Validation error: Ingrese nombre al Tipo de Dato.",
  8473. - "errors": [
  8474. - {
  8475. - "message": "Ingrese nombre al Tipo de Dato.",
  8476. - "type": "Validation error",
  8477. - "path": "nombre",
  8478. - "value": {},
  8479. - "__raw": {}
  8480. - }
  8481. - ]
  8482. - }
  8483. -
  8484. -----
  8485. -
  8486. -Eliminar Tipo de Dato
  8487. ----------------------
  8488. -
  8489. -URL
  8490. -```
  8491. -::
  8492. -
  8493. - /tiposDato/
  8494. -
  8495. -Método
  8496. -``````
  8497. -``DELETE``
  8498. -
  8499. -Parámetros de la URL
  8500. -````````````````````
  8501. -
  8502. -**Parámetro requerido:**
  8503. -
  8504. -============ ============== ================================================
  8505. -**Nombre** **Tipo** **Descripción**
  8506. -============ ============== ================================================
  8507. -`id` String Identificador único del registro en la entidad.
  8508. -============ ============== ================================================
  8509. -
  8510. -**Ejemplo:**
  8511. -::
  8512. -
  8513. - id="WEB"
  8514. -
  8515. -Respuesta correcta
  8516. -``````````````````
  8517. -
  8518. -**Código:** 204
  8519. -
  8520. -Respuesta de error
  8521. -``````````````````
  8522. -
  8523. -**Código:** 404
  8524. -
  8525. -**Contenido:**
  8526. -
  8527. -.. code:: json
  8528. -
  8529. - {
  8530. - "message": "Entidad no encontrada"
  8531. - }
  8532. diff --git a/docs/tipoEntidad/tipoEntidad.rst b/docs/tipoEntidad/tipoEntidad.rst
  8533. index 22921b4..1d7222f 100644
  8534. --- a/docs/tipoEntidad/tipoEntidad.rst
  8535. +++ b/docs/tipoEntidad/tipoEntidad.rst
  8536. @@ -1,602 +1,63 @@
  8537. -Tipo de Entidad
  8538. -===============
  8539. +Tipo Entidad
  8540. +====================
  8541.  
  8542. -Mostrar todos los tipos de entidades
  8543. -------------------------------------
  8544. -
  8545. -URL
  8546. -```
  8547. -::
  8548. -
  8549. - /tiposEntidad
  8550. -
  8551. -Método
  8552. -``````
  8553. -``GET``
  8554. -
  8555. -Respuesta correcta
  8556. -``````````````````
  8557. -
  8558. -**Código:** 200
  8559. -
  8560. -**Contenido:**
  8561. -
  8562. -.. code:: json
  8563. -
  8564. - {
  8565. - "count": 3,
  8566. - "rows": [
  8567. - {
  8568. - "_id": 1,
  8569. - "nombre": "Ministerio",
  8570. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8571. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8572. - },
  8573. - {
  8574. - "_id": 2,
  8575. - "nombre": "Viceministerio",
  8576. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8577. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8578. - },
  8579. - {
  8580. - "_id": 3,
  8581. - "nombre": "Entidad Privada",
  8582. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8583. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8584. - },
  8585. - ]
  8586. - }
  8587. -
  8588. -Parámetros opcionales de la URL
  8589. -```````````````````````````````
  8590. -Tabla de parámetros
  8591. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8592. -+-+-----------+------------------+---------------------------------------------------------------------+
  8593. -|**Nombre** |**Tipo** |**Descripción** |
  8594. -+=+===========+==================+=====================================================================+
  8595. -|`elementos` | Integer |Cantidad de elementos a mostrar. |
  8596. -+-+-----------+------------------+---------------------------------------------------------------------+
  8597. -|`pagina` | Integer |El número de página a mostrar. |
  8598. -+-+-----------+------------------+---------------------------------------------------------------------+
  8599. -|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  8600. -+-+-----------+------------------+---------------------------------------------------------------------+
  8601. -|`orden` | Boolean |TRUE para un orden descendente. |
  8602. -+-+-----------+------------------+---------------------------------------------------------------------+
  8603. -|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  8604. -+-+-----------+------------------+---------------------------------------------------------------------+
  8605. -| |`palabra` | String |Palabra que representa el criterio a buscar. |
  8606. -+-+-----------+------------------+---------------------------------------------------------------------+
  8607. -| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  8608. -+-+-----------+------------------+---------------------------------------------------------------------+
  8609. -|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  8610. -| | |(La estructura del atributo `buscar` es igual al del parámetro |
  8611. -| | |`buscar` definido anteriormente) |
  8612. -+-+-----------+------------------+---------------------------------------------------------------------+
  8613. -| |`entidad` | String |El nombre de la entidad. |
  8614. -+-+-----------+------------------+---------------------------------------------------------------------+
  8615. -
  8616. -Muestra una determinada cantidad de tipos de entidades
  8617. -''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8618. -
  8619. -**URL**
  8620. -::
  8621. -
  8622. - /tiposEntidad?elementos=valor
  8623. -
  8624. -**Parámetros usados**
  8625. -
  8626. -============ =====================
  8627. -**Nombre** **Valor enviado**
  8628. -============ =====================
  8629. -`elementos` 1
  8630. -============ =====================
  8631. -
  8632. -**Ejemplo:**
  8633. -
  8634. -::
  8635. -
  8636. - /tiposEntidad?elementos=1
  8637. -
  8638. -**Respuesta:**
  8639. -
  8640. -.. code:: json
  8641. -
  8642. - {
  8643. - "count": 3,
  8644. - "rows": [
  8645. - {
  8646. - "_id": 1,
  8647. - "nombre": "Ministerio",
  8648. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8649. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8650. - }
  8651. - ]
  8652. - }
  8653. -
  8654. -Muestra los tipos de entidades en una determinada página
  8655. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8656. -
  8657. -**URL**
  8658. -::
  8659. -
  8660. - /tiposEntidad?pagina=valor
  8661. -
  8662. -**Parámetros usados**
  8663. -
  8664. -============ =====================
  8665. -**Nombre** **Valor enviado**
  8666. -============ =====================
  8667. -`pagina` 1
  8668. -============ =====================
  8669. -
  8670. -**Ejemplo:**
  8671. -::
  8672. -
  8673. - /tiposEntidad?pagina=1
  8674. -
  8675. -**Respuesta:**
  8676. -
  8677. -.. code:: json
  8678. -
  8679. - {
  8680. - "count": 3,
  8681. - "rows": [
  8682. - {
  8683. - "_id": 1,
  8684. - "nombre": "Ministerio",
  8685. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8686. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8687. - },
  8688. - {
  8689. - "_id": 2,
  8690. - "nombre": "Viceministerio",
  8691. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8692. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8693. - },
  8694. - {
  8695. - "_id": 3,
  8696. - "nombre": "Entidad Privada",
  8697. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8698. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8699. - },
  8700. - ]
  8701. - }
  8702. -
  8703. -Ordena los tipos de entidades ascendentemente en base a un campo del modelo
  8704. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8705. -
  8706. -**URL**
  8707. -::
  8708. -
  8709. - /tiposEntidad?ordenarPor=valor
  8710. -
  8711. -**Parámetros usados**
  8712. -
  8713. -============ =====================
  8714. -**Nombre** **Valor enviado**
  8715. -============ =====================
  8716. -`ordenarPor` nombre
  8717. -============ =====================
  8718. -
  8719. -**Ejemplo**
  8720. -::
  8721. -
  8722. - /tiposEntidad?ordenarPor=nombre
  8723. -
  8724. -**Respuesta:**
  8725. -
  8726. -.. code:: json
  8727. -
  8728. - {
  8729. - "count": 3,
  8730. - "rows": [
  8731. - {
  8732. - "_id": 3,
  8733. - "nombre": "Entidad Privada",
  8734. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8735. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8736. - },
  8737. - {
  8738. - "_id": 1,
  8739. - "nombre": "Ministerio",
  8740. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8741. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8742. - },
  8743. - {
  8744. - "_id": 2,
  8745. - "nombre": "Viceministerio",
  8746. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8747. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8748. - },
  8749. - ]
  8750. - }
  8751. -
  8752. -Ordena los tipos de entidades descendentemente en base a un campo del modelo
  8753. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8754. -
  8755. -**URL**
  8756. -::
  8757. -
  8758. - /tiposEntidad?ordenarPor=valor1&orden=true
  8759. -
  8760. -**Parámetros usados**
  8761. -
  8762. -============ =================
  8763. -**Nombre** **Valor enviado**
  8764. -============ =================
  8765. -`ordenarPor` nombre
  8766. -`orden` true
  8767. -============ =================
  8768. -
  8769. -**Ejemplo:**
  8770. -::
  8771. -
  8772. - /tiposEntidad?ordenarPor=nombre&orden=true
  8773. -
  8774. -**Respuesta:**
  8775. -
  8776. -.. code:: json
  8777. -
  8778. - {
  8779. - "count": 3,
  8780. - "rows": [
  8781. - {
  8782. - "_id": 2,
  8783. - "nombre": "Viceministerio",
  8784. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8785. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8786. - },
  8787. - {
  8788. - "_id": 1,
  8789. - "nombre": "Ministerio",
  8790. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8791. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8792. - },
  8793. - {
  8794. - "_id": 3,
  8795. - "nombre": "Entidad Privada",
  8796. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8797. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8798. - },
  8799. - ]
  8800. - }
  8801. -
  8802. -Buscar por "palabra" en "campo" en el modelo "Tipo de entidad"
  8803. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  8804. -
  8805. -**URL**
  8806. -::
  8807. -
  8808. - /tiposEntidad?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  8809. -
  8810. -**Parámetros usados**
  8811. -
  8812. -============ ===========================================
  8813. -**Nombre** **Valor enviado**
  8814. -============ ===========================================
  8815. -`buscar` ::
  8816. -
  8817. - [{"en":"nombre","palabra":"ministerio"}]
  8818. -============ ===========================================
  8819. -
  8820. -**Ejemplo**
  8821. -::
  8822. -
  8823. - /tiposEntidad?buscar=%7B%22en%22:%22nombre%22,%22palabra%22:%22ministerio%22%7D
  8824. -
  8825. -**Respuesta:**
  8826. -
  8827. -.. code:: json
  8828. -
  8829. - {
  8830. - "count": 2,
  8831. - "rows": [
  8832. - {
  8833. - "_id": 1,
  8834. - "nombre": "Ministerio",
  8835. - "fecha_creacion": "2016-04-27T15:43:27.717Z",
  8836. - "fecha_modificacion": "2016-04-27T15:43:27.717Z"
  8837. - },
  8838. - {
  8839. - "_id": 2,
  8840. - "nombre": "Viceministerio",
  8841. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8842. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8843. - }
  8844. - ]
  8845. - }
  8846. -
  8847. -Respuesta de error
  8848. -``````````````````
  8849. -
  8850. -**Código:** 500
  8851. -
  8852. -**Contenido:**
  8853. -
  8854. -.. code:: json
  8855. -
  8856. - {
  8857. - "error":"Ocurrio un problema inesperado en el servidor"
  8858. - }
  8859. -
  8860. -
  8861. -Observaciones
  8862. -`````````````
  8863. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  8864. -- El parámetro 'orden' depende de 'ordenarPor'
  8865. -- El parámetro 'pagina' muestra 15 tipos de entidades por defecto
  8866. -
  8867. -----
  8868. -
  8869. -Crear un tipo de entidad
  8870. +Formato URL
  8871. ------------------------
  8872. -
  8873. -URL
  8874. -```
  8875. -::
  8876. -
  8877. - /tiposEntidad
  8878. -
  8879. -Método
  8880. -``````
  8881. -``POST``
  8882. -
  8883. -Parámetros del body
  8884. -```````````````````
  8885. -**Ejemplo**
  8886. -
  8887. -.. code:: json
  8888. -
  8889. - {
  8890. - "nombre": "Agencia"
  8891. - }
  8892. -
  8893. -Respuesta correcta
  8894. -``````````````````
  8895. -
  8896. -**Código:** 201
  8897. -
  8898. -**Contenido:**
  8899. -
  8900. -.. code:: json
  8901. -
  8902. - {
  8903. - "_id": 4,
  8904. - "nombre": "Entidad",
  8905. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8906. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8907. - }
  8908. -
  8909. -Respuesta de error
  8910. -``````````````````
  8911. -
  8912. -**Código:** 400
  8913. -
  8914. -**Contenido:**
  8915. -
  8916. -.. code:: json
  8917. -
  8918. - {
  8919. - "name": "SequelizeValidationError",
  8920. - "message": "Validation error: Ingrese un tipo de Entidad.",
  8921. - "errors": [
  8922. - {
  8923. - "message": "Ingrese un tipo de Entidad.",
  8924. - "type": "Validation error",
  8925. - "path": "nombre",
  8926. - "value": {},
  8927. - "__raw": {}
  8928. - }
  8929. - ]
  8930. - }
  8931. -
  8932. -**Código:** 409
  8933. -
  8934. -**Contenido:**
  8935. -
  8936. -.. code:: json
  8937. -
  8938. - {
  8939. - "name": "SequelizeUniqueConstraintError",
  8940. - "message": "llave duplicada viola restricción de unicidad «unidad_organizacional_nombre_key»",
  8941. - "errors": {}
  8942. - }
  8943. -
  8944. -----
  8945. -
  8946. -Mostrar un tipo de entidad
  8947. ---------------------------
  8948. -URL
  8949. -```
  8950. -::
  8951. -
  8952. - /tiposEntidad/:id
  8953. -
  8954. -Método
  8955. -``````
  8956. -``GET``
  8957. -
  8958. -Parámetros de la URL
  8959. -````````````````````
  8960. -
  8961. -**Parámetro requerido:**
  8962. -
  8963. -============ ============== ================================================
  8964. -**Nombre** **Tipo** **Descripción**
  8965. -============ ============== ================================================
  8966. -`id` Integer Identificador único del registro en la entidad.
  8967. -============ ============== ================================================
  8968. -
  8969. -**Ejemplo**
  8970. -::
  8971. -
  8972. - id=4
  8973. -
  8974. -Respuesta correcta
  8975. -``````````````````
  8976. -
  8977. -**Código:** 200
  8978. -
  8979. -**Ejemplo**
  8980. -
  8981. -.. code:: json
  8982. -
  8983. - {
  8984. - "_id": 4,
  8985. - "nombre": "Entidad",
  8986. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  8987. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  8988. - }
  8989. -
  8990. -Respuesta de error
  8991. -``````````````````
  8992. -
  8993. -**Código:** 404
  8994. -
  8995. -**Contenido:**
  8996. -
  8997. -.. code:: json
  8998. -
  8999. - {
  9000. - "message": "Entidad no encontrada"
  9001. - }
  9002. -
  9003. -----
  9004. -
  9005. -Editar un tipo de entidad
  9006. --------------------------
  9007. -URL
  9008. -```
  9009. -::
  9010. -
  9011. - /tiposEntidad/:id
  9012. -
  9013. -Método
  9014. -``````
  9015. -``PUT``
  9016. -
  9017. -Parámetros de la URL
  9018. -````````````````````
  9019. -
  9020. -**Parámetro requerido:**
  9021. -
  9022. -============ ============== ================================================
  9023. -**Nombre** **Tipo** **Descripción**
  9024. -============ ============== ================================================
  9025. -`id` Integer Identificador único del registro en la entidad.
  9026. -============ ============== ================================================
  9027. -
  9028. -**Ejemplo**
  9029. -::
  9030. -
  9031. - id=4
  9032. -
  9033. -Parámetros del body
  9034. -```````````````````
  9035. -
  9036. -**Ejemplo**
  9037. -
  9038. -.. code:: json
  9039. -
  9040. - {
  9041. - "nombre": "Entidad Gubernamental"
  9042. - }
  9043. -
  9044. -
  9045. -Respuesta correcta
  9046. -``````````````````
  9047. -
  9048. -**Código:** 200
  9049. -
  9050. -**Contenido:**
  9051. -
  9052. -.. code:: json
  9053. -
  9054. - {
  9055. - "_id": 4,
  9056. - "nombre": "Entidad Gubernamental",
  9057. - "fecha_creacion": "2016-04-27T15:43:55.908Z",
  9058. - "fecha_modificacion": "2016-04-27T15:43:55.908Z"
  9059. - }
  9060. -
  9061. -Respuesta de error
  9062. -``````````````````
  9063. -
  9064. -**Código:** 404
  9065. -
  9066. -**Contenido:**
  9067. -
  9068. -.. code:: json
  9069. -
  9070. - {
  9071. - "message": "Entidad no encontrada"
  9072. - }
  9073. -
  9074. -
  9075. -**Código:** 400
  9076. -
  9077. -**Contenido:**
  9078. -
  9079. -.. code:: json
  9080. -
  9081. - {
  9082. - "name": "SequelizeValidationError",
  9083. - "message": "Validation error: Ingrese un tipo de Entidad.",
  9084. - "errors": [
  9085. - {
  9086. - "message": "Ingrese un tipo de Entidad.",
  9087. - "type": "Validation error",
  9088. - "path": "nombre",
  9089. - "value": {},
  9090. - "__raw": {}
  9091. - }
  9092. - ]
  9093. - }
  9094. -
  9095. -----
  9096. -
  9097. -Eliminar un tipo de entidad
  9098. ----------------------------
  9099. -URL
  9100. -```
  9101. -::
  9102. -
  9103. - /tiposEntidad/:id
  9104. -
  9105. -Método
  9106. -``````
  9107. -``DELETE``
  9108. -
  9109. -Parámetros de la URL
  9110. -````````````````````
  9111. -
  9112. -**Parámetro requerido:**
  9113. -
  9114. -============ ============== ================================================
  9115. -**Nombre** **Tipo** **Descripción**
  9116. -============ ============== ================================================
  9117. -`id` Integer Identificador único del registro en la entidad.
  9118. -============ ============== ================================================
  9119. -
  9120. -**Ejemplo**
  9121. -::
  9122. -
  9123. - id=4
  9124. -
  9125. -Respuesta correcta
  9126. -``````````````````
  9127. -
  9128. -**Código:** 204
  9129. -
  9130. -Respuesta de error
  9131. -``````````````````
  9132. -
  9133. -**Código:** 404
  9134. -
  9135. -**Contenido:**
  9136. -
  9137. -.. code:: json
  9138. -
  9139. - {
  9140. - "message": "Entidad no encontrada"
  9141. - }
  9142. ++-----------------+-------------------------+
  9143. +|**Método HTTP** |**Significado** |
  9144. ++=================+=========================+
  9145. +|`GET` | Obtiene un recurso |
  9146. ++-----------------+-------------------------+
  9147. +|`POST` | Crea un recurso |
  9148. ++-----------------+-------------------------+
  9149. +|`PUT` | Actualiza un recurso |
  9150. ++-----------------+-------------------------+
  9151. +|`DELETE` | Borra un recurso |
  9152. ++-----------------+-------------------------+
  9153. +
  9154. +Ejemplo
  9155. +''''''''''''
  9156. +
  9157. +**Contenido Body**
  9158. +
  9159. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  9160. +
  9161. +.. code:: json
  9162. +
  9163. + {
  9164. + "nombre": "Entidad Descentralizada",
  9165. + "fecha_creacion": "2016-07-26T14:37:06.822Z",
  9166. + "fecha_modificacion": "2016-07-26T14:37:06.822Z"
  9167. + }
  9168. +
  9169. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9170. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  9171. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  9172. +| /tiposEntidad | Obtiene el listado de todos los Tipo Entidad | Crea un registro de Tipo Entidad | | |
  9173. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9174. +| /tiposEntidad/:id | Obtiene el Tipo Entidad identificado como :id | | Actualiza registro :id de Tipo Entidad | Elimina registro :id de Tipo Entidad |
  9175. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9176. +
  9177. +
  9178. +Respuestas
  9179. +----------
  9180. +
  9181. ++------------------+----------------------------------------------------------------------------------------------+
  9182. +| **Código HTTP** | **Descripción** |
  9183. ++==================+==============================================================================================+
  9184. +| `200` | Ok |
  9185. ++------------------+----------------------------------------------------------------------------------------------+
  9186. +| `201` | Creado |
  9187. ++------------------+----------------------------------------------------------------------------------------------+
  9188. +| `400` | Parámetros incorrectos en la entrada |
  9189. ++------------------+----------------------------------------------------------------------------------------------+
  9190. +| `401` | Token de acceso expirado o invalido |
  9191. ++------------------+----------------------------------------------------------------------------------------------+
  9192. +| `404` | Recurso no encontrado |
  9193. ++------------------+----------------------------------------------------------------------------------------------+
  9194. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  9195. ++------------------+----------------------------------------------------------------------------------------------+
  9196. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  9197. ++------------------+----------------------------------------------------------------------------------------------+
  9198. +| `500` | Error interno del servidor |
  9199. ++------------------+----------------------------------------------------------------------------------------------+
  9200. diff --git a/docs/tipo_dato/tipo_dato.rst b/docs/tipo_dato/tipo_dato.rst
  9201. new file mode 100644
  9202. index 0000000..3599415
  9203. --- /dev/null
  9204. +++ b/docs/tipo_dato/tipo_dato.rst
  9205. @@ -0,0 +1,91 @@
  9206. +Tipo Dato
  9207. +====================
  9208. +
  9209. +Formato URL
  9210. +------------------------
  9211. ++-----------------+-------------------------+
  9212. +|**Método HTTP** |**Significado** |
  9213. ++=================+=========================+
  9214. +|`GET` | Obtiene un recurso |
  9215. ++-----------------+-------------------------+
  9216. +|`POST` | Crea un recurso |
  9217. ++-----------------+-------------------------+
  9218. +|`PUT` | Actualiza un recurso |
  9219. ++-----------------+-------------------------+
  9220. +|`DELETE` | Borra un recurso |
  9221. ++-----------------+-------------------------+
  9222. +
  9223. +Ejemplo
  9224. +''''''''''''
  9225. +
  9226. +**Contenido Body**
  9227. +
  9228. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  9229. +
  9230. +.. code:: json
  9231. +
  9232. + {
  9233. + "propiedad": "EMAIL",
  9234. + "nombre": "Correo Electrónico",
  9235. + "createdAt": "2016-03-14T22:52:31.554Z",
  9236. + "updatedAt": "2016-03-14T22:52:31.554Z",
  9237. + "deletedAt": null
  9238. + }
  9239. +
  9240. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9241. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  9242. ++=====================================================+===============================================================================================+====================================================+===============================================+==============================================+
  9243. +| /tiposDato | Obtiene el listado de todos los Tipo Dato | Crea un registro de Tipo Dato | | |
  9244. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9245. +| /tiposDato/:id | Obtiene el Tipo Dato identificado como :id | | Actualiza registro :id de Tipo Dato | Elimina registro :id de Tipo Dato |
  9246. ++-----------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+-----------------------------------------------+----------------------------------------------+
  9247. +
  9248. +Tabla de parámetros opcionales de la URL para peticines GET
  9249. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9250. ++-+-----------+------------------+---------------------------------------------------------------------+
  9251. +|**Nombre** |**Tipo** |**Descripción** |
  9252. ++=+===========+==================+=====================================================================+
  9253. +|`elementos` | Integer |Cantidad de elementos a mostrar. |
  9254. ++-+-----------+------------------+---------------------------------------------------------------------+
  9255. +|`pagina` | Integer |El número de página a mostrar. |
  9256. ++-+-----------+------------------+---------------------------------------------------------------------+
  9257. +|`ordenarPor` | String |El nombre del campo correspondiente al modelo de la entidad. |
  9258. ++-+-----------+------------------+---------------------------------------------------------------------+
  9259. +|`orden` | Boolean |TRUE para un orden descendente. |
  9260. ++-+-----------+------------------+---------------------------------------------------------------------+
  9261. +|`buscar` | Object (array) |Cada objeto del array contiene los atributos: `palabra` y `en`. |
  9262. ++-+-----------+------------------+---------------------------------------------------------------------+
  9263. +| |`palabra` | String |Palabra que representa el criterio a buscar. |
  9264. ++-+-----------+------------------+---------------------------------------------------------------------+
  9265. +| |`en` | String |El nombre de campo en el cual se realiza la busqueda de `palabra`. |
  9266. ++-+-----------+------------------+---------------------------------------------------------------------+
  9267. +|`incluye` | Object (array) |Cada objeto del array contiene los atributos: `entidad` y `buscar`. |
  9268. +| | |(La estructura del atributo `buscar` es igual al del parámetro |
  9269. +| | |`buscar` definido anteriormente) |
  9270. ++-+-----------+------------------+---------------------------------------------------------------------+
  9271. +| |`entidad` | String |El nombre de la entidad. |
  9272. ++-+-----------+------------------+---------------------------------------------------------------------+
  9273. +
  9274. +
  9275. +Respuestas
  9276. +----------
  9277. +
  9278. ++------------------+----------------------------------------------------------------------------------------------+
  9279. +| **Código HTTP** | **Descripción** |
  9280. ++==================+==============================================================================================+
  9281. +| `200` | Ok |
  9282. ++------------------+----------------------------------------------------------------------------------------------+
  9283. +| `201` | Creado |
  9284. ++------------------+----------------------------------------------------------------------------------------------+
  9285. +| `400` | Parámetros incorrectos en la entrada |
  9286. ++------------------+----------------------------------------------------------------------------------------------+
  9287. +| `401` | Token de acceso expirado o invalido |
  9288. ++------------------+----------------------------------------------------------------------------------------------+
  9289. +| `404` | Recurso no encontrado |
  9290. ++------------------+----------------------------------------------------------------------------------------------+
  9291. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  9292. ++------------------+----------------------------------------------------------------------------------------------+
  9293. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  9294. ++------------------+----------------------------------------------------------------------------------------------+
  9295. +| `500` | Error interno del servidor |
  9296. ++------------------+----------------------------------------------------------------------------------------------+
  9297. diff --git a/docs/unidadOrganizacional/unidadOrganizacional.rst b/docs/unidadOrganizacional/unidadOrganizacional.rst
  9298. index 871d4b6..0ac7f30 100644
  9299. --- a/docs/unidadOrganizacional/unidadOrganizacional.rst
  9300. +++ b/docs/unidadOrganizacional/unidadOrganizacional.rst
  9301. @@ -1,98 +1,55 @@
  9302. -Unidad Organizacional
  9303. -=====================
  9304. -
  9305. -Mostrar todas las unidades organizacionales
  9306. --------------------------------------------
  9307. -
  9308. -URL
  9309. -```
  9310. -::
  9311. -
  9312. - /unidadesOrganizacional
  9313. -
  9314. -Método
  9315. -``````
  9316. -``GET``
  9317. -
  9318. -Respuesta correcta
  9319. -``````````````````
  9320. -
  9321. -**Código:** 200
  9322. -
  9323. -**Contenido:**
  9324. -
  9325. -.. code:: json
  9326. -
  9327. - {
  9328. - "count": 4,
  9329. - "rows": [
  9330. - {
  9331. - "_id": 89,
  9332. - "nombre": "Dirección Ejecutiva",
  9333. - "sigla": "DE",
  9334. - "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9335. - "paginaWeb": null,
  9336. - "correo": null,
  9337. - "estado": true,
  9338. - "fecha_supresion": null,
  9339. - "unidad_superior_id": null,
  9340. - "fecha_creacion": "2016-05-24T13:54:00.941Z",
  9341. - "fecha_modificacion": "2016-05-24T13:54:00.943Z",
  9342. - "hierarchyLevel": 1,
  9343. - "fk_entidad": 23
  9344. - },
  9345. - {
  9346. - "_id": 90,
  9347. - "nombre": "Unidad de Innovación y Desarrollo",
  9348. - "sigla": "UID",
  9349. - "descripcion": "Encargada de unir los esfuerzos de las diferentes líneas de investigación de la ADSIB para el desarrollo de nuevos productos que impacten positivamente al pais",
  9350. - "paginaWeb": null,
  9351. - "correo": null,
  9352. - "estado": true,
  9353. - "fecha_supresion": null,
  9354. - "unidad_superior_id": 89,
  9355. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9356. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9357. - "hierarchyLevel": 2,
  9358. - "fk_entidad": 23
  9359. - },
  9360. - {
  9361. - "_id": 91,
  9362. - "nombre": "Unidad Administrativa Financiera",
  9363. - "sigla": "UAF",
  9364. - "descripcion": "Encargada de la gestión administrativa y financiera, y el seguimiento de todos los procesos que implican el manejo de recursos económicos.",
  9365. - "paginaWeb": null,
  9366. - "correo": null,
  9367. - "estado": true,
  9368. - "fecha_supresion": null,
  9369. - "unidad_superior_id": 89,
  9370. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9371. - "fecha_modificacion": "2016-05-24T13:54:01.010Z",
  9372. - "hierarchyLevel": 2,
  9373. - "fk_entidad": 23
  9374. - },
  9375. - {
  9376. - "_id": 92,
  9377. - "nombre": "Unidad de Administración de Sistemas y Soporte Técnico",
  9378. - "sigla": "UASST",
  9379. - "descripcion": "Encargada del mantenimiento preventivo-correctivo de los equipos periféricos de computación y herramientas de software adquiridos e instalados en la ADSIB",
  9380. - "paginaWeb": null,
  9381. - "correo": null,
  9382. - "estado": true,
  9383. - "fecha_supresion": null,
  9384. - "unidad_superior_id": 89,
  9385. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9386. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9387. - "hierarchyLevel": 2,
  9388. - "fk_entidad": 23
  9389. - }
  9390. - ]
  9391. - }
  9392. -
  9393. -Parámetros opcionales de la URL
  9394. -```````````````````````````````
  9395. -Tabla de parámetros
  9396. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9397. +Comentario
  9398. +====================
  9399. +
  9400. +Formato URL
  9401. +------------------------
  9402. ++-----------------+-------------------------+
  9403. +|**Método HTTP** |**Significado** |
  9404. ++=================+=========================+
  9405. +|`GET` | Obtiene un recurso |
  9406. ++-----------------+-------------------------+
  9407. +|`POST` | Crea un recurso |
  9408. ++-----------------+-------------------------+
  9409. +|`PUT` | Actualiza un recurso |
  9410. ++-----------------+-------------------------+
  9411. +|`DELETE` | Borra un recurso |
  9412. ++-----------------+-------------------------+
  9413. +
  9414. +Ejemplo
  9415. +''''''''''''
  9416. +
  9417. +**Contenido Body**
  9418. +
  9419. +Contenido en data del cuerpo para realizar el creado y actualización de un registro identificado como :id.
  9420. +
  9421. +.. code:: json
  9422. +
  9423. + {
  9424. + "nombre": "Dirección Ejecutiva",
  9425. + "sigla": "DE",
  9426. + "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9427. + "paginaWeb": null,
  9428. + "correo": null,
  9429. + "estado": true,
  9430. + "fecha_supresion": null,
  9431. + "unidad_superior_id": null,
  9432. + "orden": 0,
  9433. + "fecha_creacion": "2016-07-26T14:37:06.901Z",
  9434. + "fecha_modificacion": "2016-07-26T14:37:06.904Z",
  9435. + "fk_entidad": 109
  9436. + }
  9437. +
  9438. ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+---------------------------------------------------------+
  9439. +|**Recurso** |**GET** |**POST** |**PUT** |**DELETE** |
  9440. ++================================================================+===============================================================================================+====================================================+==========================================================+=========================================================+
  9441. +| /unidadesOrganizacional | Obtiene el listado de todos las Unidad Organizacional | Crea un registro de Unidad Organizacional | | |
  9442. ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+---------------------------------------------------------+
  9443. +| /unidadesOrganizacional/:id | Obtiene el Unidad Organizacional identificado como :id | | Actualiza registro :id de Unidad Organizacional | Elimina registro :id de Unidad Organizacional |
  9444. ++----------------------------------------------------------------+-----------------------------------------------------------------------------------------------+----------------------------------------------------+----------------------------------------------------------+---------------------------------------------------------+
  9445. +
  9446. +
  9447. +Tabla de parámetros opcionales de la URL para peticines GET
  9448. +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9449. +-+-----------+------------------+---------------------------------------------------------------------+
  9450. |**Nombre** |**Tipo** |**Descripción** |
  9451. +=+===========+==================+=====================================================================+
  9452. @@ -117,726 +74,25 @@ Tabla de parámetros
  9453. | |`entidad` | String |El nombre de la entidad. |
  9454. +-+-----------+------------------+---------------------------------------------------------------------+
  9455.  
  9456. -Muestra una determinada cantidad de unidades organizacionales
  9457. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9458. -
  9459. -**URL**
  9460. -::
  9461. -
  9462. - /unidadesOrganizacional?elementos=valor
  9463. -
  9464. -**Parámetros usados**
  9465. -
  9466. -============ =====================
  9467. -**Nombre** **Valor enviado**
  9468. -============ =====================
  9469. -`elementos` 1
  9470. -============ =====================
  9471. -
  9472. -**Ejemplo:**
  9473. -
  9474. -::
  9475. -
  9476. - /unidadesOrganizacional?elementos=1
  9477. -
  9478. -**Respuesta:**
  9479. -
  9480. -.. code:: json
  9481. -
  9482. - {
  9483. - "count": 4,
  9484. - "rows": [
  9485. - {
  9486. - "_id": 89,
  9487. - "nombre": "Dirección Ejecutiva",
  9488. - "sigla": "DE",
  9489. - "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9490. - "paginaWeb": null,
  9491. - "correo": null,
  9492. - "estado": true,
  9493. - "fecha_supresion": null,
  9494. - "unidad_superior_id": null,
  9495. - "fecha_creacion": "2016-05-24T13:54:00.941Z",
  9496. - "fecha_modificacion": "2016-05-24T13:54:00.943Z",
  9497. - "hierarchyLevel": 1,
  9498. - "fk_entidad": 23
  9499. - }
  9500. - ]
  9501. - }
  9502. -
  9503. -Muestra las unidades organizacionales en una determinada página
  9504. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9505. -
  9506. -**URL**
  9507. -::
  9508. -
  9509. - /unidadesOrganizacional?pagina=valor
  9510. -
  9511. -**Parámetros usados**
  9512. -
  9513. -============ =====================
  9514. -**Nombre** **Valor enviado**
  9515. -============ =====================
  9516. -`pagina` 1
  9517. -============ =====================
  9518. -
  9519. -**Ejemplo:**
  9520. -::
  9521. -
  9522. - /unidadesOrganizacional?pagina=1
  9523. -
  9524. -**Respuesta:**
  9525. -
  9526. -.. code:: json
  9527. -
  9528. - {
  9529. - "count": 4,
  9530. - "rows": [
  9531. - {
  9532. - "_id": 89,
  9533. - "nombre": "Dirección Ejecutiva",
  9534. - "sigla": "DE",
  9535. - "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9536. - "paginaWeb": null,
  9537. - "correo": null,
  9538. - "estado": true,
  9539. - "fecha_supresion": null,
  9540. - "unidad_superior_id": null,
  9541. - "fecha_creacion": "2016-05-24T13:54:00.941Z",
  9542. - "fecha_modificacion": "2016-05-24T13:54:00.943Z",
  9543. - "hierarchyLevel": 1,
  9544. - "fk_entidad": 23
  9545. - },
  9546. - {
  9547. - "_id": 90,
  9548. - "nombre": "Unidad de Innovación y Desarrollo",
  9549. - "sigla": "UID",
  9550. - "descripcion": "Encargada de unir los esfuerzos de las diferentes líneas de investigación de la ADSIB para el desarrollo de nuevos productos que impacten positivamente al pais",
  9551. - "paginaWeb": null,
  9552. - "correo": null,
  9553. - "estado": true,
  9554. - "fecha_supresion": null,
  9555. - "unidad_superior_id": 89,
  9556. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9557. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9558. - "hierarchyLevel": 2,
  9559. - "fk_entidad": 23
  9560. - },
  9561. - {
  9562. - "_id": 91,
  9563. - "nombre": "Unidad Administrativa Financiera",
  9564. - "sigla": "UAF",
  9565. - "descripcion": "Encargada de la gestión administrativa y financiera, y el seguimiento de todos los procesos que implican el manejo de recursos económicos.",
  9566. - "paginaWeb": null,
  9567. - "correo": null,
  9568. - "estado": true,
  9569. - "fecha_supresion": null,
  9570. - "unidad_superior_id": 89,
  9571. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9572. - "fecha_modificacion": "2016-05-24T13:54:01.010Z",
  9573. - "hierarchyLevel": 2,
  9574. - "fk_entidad": 23
  9575. - },
  9576. - {
  9577. - "_id": 92,
  9578. - "nombre": "Unidad de Administración de Sistemas y Soporte Técnico",
  9579. - "sigla": "UASST",
  9580. - "descripcion": "Encargada del mantenimiento preventivo-correctivo de los equipos periféricos de computación y herramientas de software adquiridos e instalados en la ADSIB",
  9581. - "paginaWeb": null,
  9582. - "correo": null,
  9583. - "estado": true,
  9584. - "fecha_supresion": null,
  9585. - "unidad_superior_id": 89,
  9586. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9587. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9588. - "hierarchyLevel": 2,
  9589. - "fk_entidad": 23
  9590. - }
  9591. - ]
  9592. - }
  9593. -
  9594. -Ordena las unidades organizacionales ascendentemente en base a un campo del modelo
  9595. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9596. -
  9597. -**URL**
  9598. -::
  9599. -
  9600. - /unidadesOrganizacional?ordenarPor=valor
  9601. -
  9602. -**Parámetros usados**
  9603. -
  9604. -============ =====================
  9605. -**Nombre** **Valor enviado**
  9606. -============ =====================
  9607. -`ordenarPor` sigla
  9608. -============ =====================
  9609. -
  9610. -**Ejemplo**
  9611. -::
  9612. -
  9613. - /unidadesOrganizacional?ordenarPor=nombre
  9614. -
  9615. -**Respuesta:**
  9616. -
  9617. -.. code:: json
  9618. -
  9619. - {
  9620. - "count": 4,
  9621. - "rows": [
  9622. - {
  9623. - "_id": 89,
  9624. - "nombre": "Dirección Ejecutiva",
  9625. - "sigla": "DE",
  9626. - "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9627. - "paginaWeb": null,
  9628. - "correo": null,
  9629. - "estado": true,
  9630. - "fecha_supresion": null,
  9631. - "unidad_superior_id": null,
  9632. - "fecha_creacion": "2016-05-24T15:15:31.301Z",
  9633. - "fecha_modificacion": "2016-05-24T15:15:31.302Z",
  9634. - "hierarchyLevel": 1,
  9635. - "fk_entidad": 23
  9636. - },
  9637. - {
  9638. - "_id": 91,
  9639. - "nombre": "Unidad Administrativa Financiera",
  9640. - "sigla": "UAF",
  9641. - "descripcion": "Encargada de la gestión administrativa y financiera, y el seguimiento de todos los procesos que implican el manejo de recursos económicos.",
  9642. - "paginaWeb": null,
  9643. - "correo": null,
  9644. - "estado": true,
  9645. - "fecha_supresion": null,
  9646. - "unidad_superior_id": 89,
  9647. - "fecha_creacion": "2016-05-24T15:15:31.316Z",
  9648. - "fecha_modificacion": "2016-05-24T15:15:31.319Z",
  9649. - "hierarchyLevel": 2,
  9650. - "fk_entidad": 23
  9651. - },
  9652. - {
  9653. - "_id": 92,
  9654. - "nombre": "Unidad de Administración de Sistemas y Soporte Técnico",
  9655. - "sigla": "UASST",
  9656. - "descripcion": "Encargada del mantenimiento preventivo-correctivo de los equipos periféricos de computación y herramientas de software adquiridos e instalados en la ADSIB",
  9657. - "paginaWeb": null,
  9658. - "correo": null,
  9659. - "estado": true,
  9660. - "fecha_supresion": null,
  9661. - "unidad_superior_id": 89,
  9662. - "fecha_creacion": "2016-05-24T15:15:31.316Z",
  9663. - "fecha_modificacion": "2016-05-24T15:15:31.319Z",
  9664. - "hierarchyLevel": 2,
  9665. - "fk_entidad": 23
  9666. - },
  9667. - {
  9668. - "_id": 90,
  9669. - "nombre": "Unidad de Innovación y Desarrollo",
  9670. - "sigla": "UID",
  9671. - "descripcion": "Encargada de unir los esfuerzos de las diferentes líneas de investigación de la ADSIB para el desarrollo de nuevos productos que impacten positivamente al pais",
  9672. - "paginaWeb": null,
  9673. - "correo": null,
  9674. - "estado": true,
  9675. - "fecha_supresion": null,
  9676. - "unidad_superior_id": 89,
  9677. - "fecha_creacion": "2016-05-24T15:15:31.316Z",
  9678. - "fecha_modificacion": "2016-05-24T15:15:31.319Z",
  9679. - "hierarchyLevel": 2,
  9680. - "fk_entidad": 23
  9681. - }
  9682. - ]
  9683. - }
  9684. -
  9685. -Ordena las unidades organizacionales descendentemente base a un campo del modelo
  9686. -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9687. -
  9688. -**URL**
  9689. -::
  9690. -
  9691. - /unidadesOrganizacional?ordenarPor=valor1&orden=valor2
  9692. -
  9693. -**Parámetros usados**
  9694. -
  9695. -============ =================
  9696. -**Nombre** **Valor enviado**
  9697. -============ =================
  9698. -`ordenarPor` sigla
  9699. -`orden` true
  9700. -============ =================
  9701. -
  9702. -**Ejemplo:**
  9703. -::
  9704. -
  9705. - /unidadesOrganizacional?ordenarPor=sigla&orden=true
  9706. -
  9707. -**Respuesta:**
  9708. -
  9709. -.. code:: json
  9710. -
  9711. - {
  9712. - "count": 4,
  9713. - "rows": [
  9714. - {
  9715. - "_id": 90,
  9716. - "nombre": "Unidad de Innovación y Desarrollo",
  9717. - "sigla": "UID",
  9718. - "descripcion": "Encargada de unir los esfuerzos de las diferentes líneas de investigación de la ADSIB para el desarrollo de nuevos productos que impacten positivamente al pais",
  9719. - "paginaWeb": null,
  9720. - "correo": null,
  9721. - "estado": true,
  9722. - "fecha_supresion": null,
  9723. - "unidad_superior_id": 89,
  9724. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9725. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9726. - "hierarchyLevel": 2,
  9727. - "fk_entidad": 23
  9728. - },
  9729. - {
  9730. - "_id": 92,
  9731. - "nombre": "Unidad de Administración de Sistemas y Soporte Técnico",
  9732. - "sigla": "UASST",
  9733. - "descripcion": "Encargada del mantenimiento preventivo-correctivo de los equipos periféricos de computación y herramientas de software adquiridos e instalados en la ADSIB",
  9734. - "paginaWeb": null,
  9735. - "correo": null,
  9736. - "estado": true,
  9737. - "fecha_supresion": null,
  9738. - "unidad_superior_id": 89,
  9739. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9740. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9741. - "hierarchyLevel": 2,
  9742. - "fk_entidad": 23
  9743. - },
  9744. - {
  9745. - "_id": 91,
  9746. - "nombre": "Unidad Administrativa Financiera",
  9747. - "sigla": "UAF",
  9748. - "descripcion": "Encargada de la gestión administrativa y financiera, y el seguimiento de todos los procesos que implican el manejo de recursos económicos.",
  9749. - "paginaWeb": null,
  9750. - "correo": null,
  9751. - "estado": true,
  9752. - "fecha_supresion": null,
  9753. - "unidad_superior_id": 89,
  9754. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9755. - "fecha_modificacion": "2016-05-24T13:54:01.010Z",
  9756. - "hierarchyLevel": 2,
  9757. - "fk_entidad": 23
  9758. - },
  9759. - {
  9760. - "_id": 89,
  9761. - "nombre": "Dirección Ejecutiva",
  9762. - "sigla": "DE",
  9763. - "descripcion": "Responsable del macro-proceso de Gestión Estratégica Institucional de la ADSIB",
  9764. - "paginaWeb": null,
  9765. - "correo": null,
  9766. - "estado": true,
  9767. - "fecha_supresion": null,
  9768. - "unidad_superior_id": null,
  9769. - "fecha_creacion": "2016-05-24T13:54:00.941Z",
  9770. - "fecha_modificacion": "2016-05-24T13:54:00.943Z",
  9771. - "hierarchyLevel": 1,
  9772. - "fk_entidad": 23
  9773. - }
  9774. - ]
  9775. - }
  9776. -
  9777. -Buscar por "palabra" en "campo" de la entidad Unidad organizacional
  9778. -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
  9779. -
  9780. -**URL**
  9781. -::
  9782. -
  9783. - /unidadesOrganizacional?buscar=%7B%22en%22:%22valor1%22,%22palabra%22:%22valor2%22%7D
  9784. -
  9785. -**Parámetros usados**
  9786. -
  9787. -============ ===========================================
  9788. -**Nombre** **Valor enviado**
  9789. -============ ===========================================
  9790. -`buscar` ::
  9791. -
  9792. - [{"en":"nombre","palabra":"unidad"}]
  9793. -============ ===========================================
  9794. -
  9795. -**Ejemplo**
  9796. -::
  9797. -
  9798. - /unidadesOrganizacional?buscar=%7B%22en%22:%22nombre%22,%22palabra%22:%22unidad%22%7D
  9799. -
  9800. -**Respuesta:**
  9801. -
  9802. -.. code:: json
  9803. -
  9804. - {
  9805. - "count": 3,
  9806. - "rows": [
  9807. - {
  9808. - "_id": 90,
  9809. - "nombre": "Unidad de Innovación y Desarrollo",
  9810. - "sigla": "UID",
  9811. - "descripcion": "Encargada de unir los esfuerzos de las diferentes líneas de investigación de la ADSIB para el desarrollo de nuevos productos que impacten positivamente al pais",
  9812. - "paginaWeb": null,
  9813. - "correo": null,
  9814. - "estado": true,
  9815. - "fecha_supresion": null,
  9816. - "unidad_superior_id": 89,
  9817. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9818. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9819. - "hierarchyLevel": 2,
  9820. - "fk_entidad": 23
  9821. - },
  9822. - {
  9823. - "_id": 91,
  9824. - "nombre": "Unidad Administrativa Financiera",
  9825. - "sigla": "UAF",
  9826. - "descripcion": "Encargada de la gestión administrativa y financiera, y el seguimiento de todos los procesos que implican el manejo de recursos económicos.",
  9827. - "paginaWeb": null,
  9828. - "correo": null,
  9829. - "estado": true,
  9830. - "fecha_supresion": null,
  9831. - "unidad_superior_id": 89,
  9832. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9833. - "fecha_modificacion": "2016-05-24T13:54:01.010Z",
  9834. - "hierarchyLevel": 2,
  9835. - "fk_entidad": 23
  9836. - },
  9837. - {
  9838. - "_id": 92,
  9839. - "nombre": "Unidad de Administración de Sistemas y Soporte Técnico",
  9840. - "sigla": "UASST",
  9841. - "descripcion": "Encargada del mantenimiento preventivo-correctivo de los equipos periféricos de computación y herramientas de software adquiridos e instalados en la ADSIB",
  9842. - "paginaWeb": null,
  9843. - "correo": null,
  9844. - "estado": true,
  9845. - "fecha_supresion": null,
  9846. - "unidad_superior_id": 89,
  9847. - "fecha_creacion": "2016-05-24T13:54:01.007Z",
  9848. - "fecha_modificacion": "2016-05-24T13:54:01.011Z",
  9849. - "hierarchyLevel": 2,
  9850. - "fk_entidad": 23
  9851. - }
  9852. - ]
  9853. - }
  9854. -
  9855. -Respuesta de error
  9856. -``````````````````
  9857. -
  9858. -**Código:** 500
  9859. -
  9860. -**Contenido:**
  9861. -
  9862. -.. code:: json
  9863. -
  9864. - {
  9865. - "error":"Ocurrio un problema inesperado en el servidor"
  9866. - }
  9867. -
  9868. -
  9869. -Observaciones
  9870. -`````````````
  9871. -- Esta petición cuando no existen datos almacenados en la base de datos retorna un array vacio
  9872. -- El parámetro 'orden' depende del parámetro 'ordenarPor'
  9873. -- El parámetro 'pagina' muestra 15 unidades organizacionales por defecto
  9874. -
  9875. -----
  9876. -
  9877. -Crear una unidad organizacional
  9878. --------------------------------
  9879. -
  9880. -URL
  9881. -```
  9882. -::
  9883. -
  9884. - /unidadesOrganizacional
  9885. -
  9886. -Método
  9887. -``````
  9888. -``POST``
  9889. -
  9890. -Parámetros del body
  9891. -```````````````````
  9892. -**Ejemplo**
  9893. -
  9894. -.. code:: json
  9895. -
  9896. - {
  9897. - "nombre": "Unidad de Desarrollo de Hardware",
  9898. - "sigla": "Hardware",
  9899. - "descripcion": "Investigación de nueva tecnologia sobre Hardware",
  9900. - "fk_entidad": 23,
  9901. - "estado": true
  9902. - }
  9903. -
  9904. -Respuesta correcta
  9905. -``````````````````
  9906. -
  9907. -**Código:** 201
  9908. -
  9909. -**Contenido:**
  9910. -
  9911. -.. code:: json
  9912. -
  9913. - {
  9914. - "_id": 93,
  9915. - "nombre": "Unidad de Desarrollo de Hardware",
  9916. - "sigla": "Hardware",
  9917. - "descripcion": "Investigación de nueva tecnologia sobre Hardware",
  9918. - "fk_entidad": 23,
  9919. - "estado": true,
  9920. - "fecha_modificacion": "2016-05-24T14:54:27.053Z",
  9921. - "fecha_creacion": "2016-05-24T14:54:27.053Z",
  9922. - "hierarchyLevel": 1,
  9923. - "paginaWeb": null,
  9924. - "correo": null,
  9925. - "fecha_supresion": null,
  9926. - "unidad_superior_id": null
  9927. - }
  9928. -
  9929. -Respuesta de error
  9930. -``````````````````
  9931. -
  9932. -**Código:** 400
  9933. -
  9934. -**Contenido:**
  9935. -
  9936. -.. code:: json
  9937. -
  9938. - {
  9939. - "name": "SequelizeValidationError",
  9940. - "message": "Validation error: Ingrese Sigla para la Unidad Organizacional.",
  9941. - "errors": [
  9942. - {
  9943. - "message": "Ingrese Sigla para la Unidad Organizacional.",
  9944. - "type": "Validation error",
  9945. - "path": "sigla",
  9946. - "value": {},
  9947. - "__raw": {}
  9948. - }
  9949. - ]
  9950. - }
  9951. -
  9952. -**Código:** 409
  9953. -
  9954. -**Contenido:**
  9955. -
  9956. -.. code:: json
  9957. -
  9958. - {
  9959. - "name": "SequelizeUniqueConstraintError",
  9960. - "message": "llave duplicada viola restricción de unicidad «unidad_organizacional_nombre_key»",
  9961. - "errors": {}
  9962. - }
  9963. -
  9964. -----
  9965. -
  9966. -Mostrar una unidad organizacional
  9967. ----------------------------------
  9968. -URL
  9969. -```
  9970. -::
  9971. -
  9972. - /unidadesOrganizacional/:id
  9973. -
  9974. -Método
  9975. -``````
  9976. -``GET``
  9977. -
  9978. -Parámetros de la URL
  9979. -````````````````````
  9980. -
  9981. -**Parámetro requerido:**
  9982. -
  9983. -============ ============== ================================================
  9984. -**Nombre** **Tipo** **Descripción**
  9985. -============ ============== ================================================
  9986. -`id` Integer Identificador único del registro en la entidad.
  9987. -============ ============== ================================================
  9988. -
  9989. -**Ejemplo**
  9990. -::
  9991. -
  9992. - id=93
  9993. -
  9994. -Respuesta correcta
  9995. -``````````````````
  9996. -
  9997. -**Código:** 200
  9998. -
  9999. -**Ejemplo**
  10000. -
  10001. -.. code:: json
  10002. -
  10003. - {
  10004. - "_id": 93,
  10005. - "nombre": "Unidad de Desarrollo de Hardware",
  10006. - "sigla": "Hardware",
  10007. - "descripcion": "Investigación de nueva tecnologia sobre Hardware",
  10008. - "paginaWeb": null,
  10009. - "correo": null,
  10010. - "estado": true,
  10011. - "fecha_supresion": null,
  10012. - "unidad_superior_id": null,
  10013. - "fecha_creacion": "2016-05-24T14:54:27.053Z",
  10014. - "fecha_modificacion": "2016-05-24T14:54:27.053Z",
  10015. - "hierarchyLevel": 1,
  10016. - "fk_entidad": 23
  10017. - }
  10018. -
  10019. -Respuesta de error
  10020. -``````````````````
  10021. -
  10022. -**Código:** 404
  10023. -
  10024. -**Contenido:**
  10025. -
  10026. -.. code:: json
  10027. -
  10028. - {
  10029. - "message": "Entidad no encontrada"
  10030. - }
  10031. -
  10032. -----
  10033. -
  10034. -Editar una unidad organizacional
  10035. ---------------------------------
  10036. -URL
  10037. -```
  10038. -::
  10039. -
  10040. - /unidadesOrganizacional/:id
  10041. -
  10042. -Método
  10043. -``````
  10044. -``PUT``
  10045. -
  10046. -Parámetros de la URL
  10047. -````````````````````
  10048. -
  10049. -**Parámetro requerido:**
  10050. -
  10051. -============ ============== ================================================
  10052. -**Nombre** **Tipo** **Descripción**
  10053. -============ ============== ================================================
  10054. -`id` Integer Identificador único del registro en la entidad.
  10055. -============ ============== ================================================
  10056. -
  10057. -**Ejemplo**
  10058. -::
  10059. -
  10060. - id=93
  10061. -
  10062. -Parámetros del body
  10063. -```````````````````
  10064. -
  10065. -**Ejemplo**
  10066. -
  10067. -.. code:: json
  10068. -
  10069. - {
  10070. - "sigla": "UDH"
  10071. - }
  10072. -
  10073. -
  10074. -Respuesta correcta
  10075. -``````````````````
  10076. -
  10077. -**Código:** 200
  10078. -
  10079. -**Contenido:**
  10080. -
  10081. -.. code:: json
  10082. -
  10083. - {
  10084. - "_id": 93,
  10085. - "nombre": "Unidad de Desarrollo de Hardware",
  10086. - "sigla": "UDH",
  10087. - "descripcion": "Investigación de nueva tecnologia sobre Hardware",
  10088. - "paginaWeb": null,
  10089. - "correo": null,
  10090. - "estado": true,
  10091. - "fecha_supresion": null,
  10092. - "unidad_superior_id": null,
  10093. - "fecha_creacion": "2016-05-24T14:54:27.053Z",
  10094. - "fecha_modificacion": "2016-05-24T15:00:39.780Z",
  10095. - "hierarchyLevel": 1,
  10096. - "fk_entidad": 23
  10097. - }
  10098. -
  10099. -Respuesta de error
  10100. -``````````````````
  10101. -
  10102. -**Código:** 404
  10103. -
  10104. -**Contenido:**
  10105. -
  10106. -.. code:: json
  10107. -
  10108. - {
  10109. - "message": "Entidad no encontrada"
  10110. - }
  10111. -
  10112. -**Código:** 400
  10113. -
  10114. -**Contenido:**
  10115. -
  10116. -.. code:: json
  10117. -
  10118. - {
  10119. - "name": "SequelizeValidationError",
  10120. - "message": "Validation error: Ingrese Sigla para la Unidad Organizacional.",
  10121. - "errors": [
  10122. - {
  10123. - "message": "Ingrese Sigla para la Unidad Organizacional.",
  10124. - "type": "Validation error",
  10125. - "path": "sigla",
  10126. - "value": {},
  10127. - "__raw": {}
  10128. - }
  10129. - ]
  10130. - }
  10131. -
  10132. -----
  10133. -
  10134. -Eliminar una unidad organizacional
  10135. -----------------------------------
  10136. -URL
  10137. -```
  10138. -::
  10139. -
  10140. - /unidadesOrganizacional/:id
  10141. -
  10142. -Método
  10143. -``````
  10144. -``DELETE``
  10145. -
  10146. -Parámetros de la URL
  10147. -````````````````````
  10148. -
  10149. -**Parámetro requerido:**
  10150. -
  10151. -============ ============== ================================================
  10152. -**Nombre** **Tipo** **Descripción**
  10153. -============ ============== ================================================
  10154. -`id` Integer Identificador único del registro en la entidad.
  10155. -============ ============== ================================================
  10156. -
  10157. -**Ejemplo**
  10158. -::
  10159. -
  10160. - id=93
  10161. -
  10162. -Respuesta correcta
  10163. -``````````````````
  10164. -
  10165. -**Código:** 204
  10166. -
  10167. -Respuesta de error
  10168. -``````````````````
  10169. -
  10170. -**Código:** 404
  10171. -
  10172. -**Contenido:**
  10173. -
  10174. -.. code:: json
  10175. -
  10176. - {
  10177. - "message": "Entidad no encontrada"
  10178. - }
  10179. +Respuestas
  10180. +----------
  10181. +
  10182. ++------------------+----------------------------------------------------------------------------------------------+
  10183. +| **Código HTTP** | **Descripción** |
  10184. ++==================+==============================================================================================+
  10185. +| `200` | Ok |
  10186. ++------------------+----------------------------------------------------------------------------------------------+
  10187. +| `201` | Creado |
  10188. ++------------------+----------------------------------------------------------------------------------------------+
  10189. +| `400` | Parámetros incorrectos en la entrada |
  10190. ++------------------+----------------------------------------------------------------------------------------------+
  10191. +| `401` | Token de acceso expirado o invalido |
  10192. ++------------------+----------------------------------------------------------------------------------------------+
  10193. +| `404` | Recurso no encontrado |
  10194. ++------------------+----------------------------------------------------------------------------------------------+
  10195. +| `405` | Método HTTP no esperado. Ejemplo: se esperaba un HTTP GET y se recibió un HTTP POST |
  10196. ++------------------+----------------------------------------------------------------------------------------------+
  10197. +| `429` | Se están recibiendo muchos requests de parte de tu aplicación. Se esta limitando el acceso |
  10198. ++------------------+----------------------------------------------------------------------------------------------+
  10199. +| `500` | Error interno del servidor |
  10200. ++------------------+----------------------------------------------------------------------------------------------+
  10201. --
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!