Commit 88a8a523 authored by D’jalmar Gutierrez Titirico's avatar D’jalmar Gutierrez Titirico 🚲

Merge branch 'iss02-postulante' into 'desarrollo'

Iss02 postulante

@dgutierrez @gcallejas Actualización de la documentación correspondiente a postulante.

See merge request !10
parents 3210a1b8 ee2bf3f2
###Mostrar todos los Datos de Postulantes
********
> **URL**
>>/datoPostulante
___
## Mostrar todos los Datos de Postulantes
___
> **Metodo**
>><kbd>GET</kbd>
**URL**
>/datoPostulantes
> **Parametros de la URL**
**Metodo**
><kbd>GET</kbd>
> **Parametros del body**
**Parametros de la URL**
> **Respuesta correcta**
**Parametros del body**
>> **Codigo:**
>>>200
**Respuesta correcta**
>>**Contenido:**
>>>Petición correcta.
> **Codigo:**
200
> **Respuesta de error**
>**Contenido:**
Petición correcta.
>>**Codigo:**
>>>404
**Ejemplo**
```json
[
{
"_id": 2,
"valor": "daniel@daniel.com",
"createdAt": "2016-03-14T22:03:48.216Z",
"updatedAt": "2016-03-14T22:03:48.216Z",
"fk_postulante": 1,
"propiedad": "EMAIL"
}
]
```
**Respuesta de error**
>>**Contenido:**
>>>El servicio no encontrado.
>**Codigo:**
>>404
>>**Codigo:**
>>>500
>**Contenido:**
>>El servicio no encontrado.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
>**Codigo:**
>>500
###Crear registro para Dato de Postulante
********
>**Contenido:**
>>La solicitud, no puede ser procesada por el servidor.
> **URL**
>> /postulantes
___
## Crear registro para Dato de Postulante
___
> **Metodo**
>><kbd>POST</kbd>
**URL**
> /datoPostulantes
> **Parametros de la URL**
**Metodo**
><kbd>POST</kbd>
> **Parametros del body**
>>
**Parametros de la URL**
**Parametros del body**
>
```json
{
"nombres": "Victor",
"apellidos": "Suarez",
"ci": "45678912",
"sexo": "Masculino"
"valor":"12345678",
"propiedad":"TELEFONO",
"fk_postulante":"1"
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
**Respuesta correcta**
> **Codigo:**
201
>**Contenido:**
Registro creado.
**Ejemplo**
```json
{
"_id": 3,
"valor": "email@email.net",
"propiedad": "EMAIL",
"fk_postulante": 1,
"updatedAt": "2016-03-15T22:59:34.162Z",
"createdAt": "2016-03-15T22:59:34.162Z"
}
```
>>**Contenido:**
>>>Registro creado.
**Respuesta de error**
> **Respuesta de error**
>**Codigo:**
400
>>**Codigo:**
>>>400
>**Contenido:**
Error en sintaxis de petición.
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Codigo:**
409
>>**Codigo:**
>>>409
>**Contenido:**
Conflicto registro duplicado.
>>**Contenido:**
>>>Conflicto registro duplicado.
>**Codigo:**
500
>>**Codigo:**
>>>500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
___
## Editar datos Postulante
___
###Editar datos Postulante
*******
> **URL**
>>/postulantes/
**URL**
>/datoPostulantes/
> **Metodo**
>><kbd>PUT</kbd>
**Metodo**
><kbd>PUT</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
**Parametros de la URL**
><kbd>id</kbd> Dato Postulante
> **Parametros del body**
>>
**Parametros del body**
>
```json
{
"nombres": "Victor Hugo",
"apellidos": "Suarez Perez",
"ci": "45678912",
"sexo": "Masculino"
"valor":"77776666",
"propiedad":"TELEFONO",
"fk_postulante":"1"
}
```
> **Respuesta correcta**
**Respuesta correcta**
>**Codigo:**
400
>**Contenido:**
Error en sintaxis de petición.
>**Codigo:**
404
>**Contenido:**
ID de postulante no encontrado.
>**Codigo:**
500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
___
## Eliminar registro de Dato del Postulante
___
**URL**
>/datoPostulantes/
**Metodo**
><kbd>DELETE</kbd>
**Parametros de la URL**
><kbd>id</kbd> Dato Postulante
**Parametros del body**
**Respuesta correcta**
>**Codigo:**
204
>>**Codigo:**
>>>400
>**Contenido:**
La solicitud se ha completado con exito.
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Codigo:**
404
>>**Codigo:**
>>>404
>**Contenido:**
ID de postulante no encontrado.
>>**Contenido:**
>>>ID de postulante no encontrado.
>**Codigo:**
500
>>**Codigo:**
>>>500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
___
## Obtiene Dato para un Postulante
___
###Eliminar registro de Dato del Postulante
*******
> **URL**
>>/postulantes/
**URL**
>/datoPostulantes/obtieneDato
> **Metodo**
>><kbd>DELETE</kbd>
**Metodo**
><kbd>GET</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
**Parametros de la URL**
>><kbd>id</kbd> Dato Postulante
**Parametros del body**
> **Parametros del body**
**Respuesta correcta**
> **Respuesta correcta**
> **Codigo:**
200
>>**Codigo:**
>>>204
>**Contenido:**
Petición correcta.
>>**Contenido:**
>>>La solicitud se ha completado con exito.
**Respuesta de error**
>>**Codigo:**
>>>404
>**Codigo:**
404
>>**Contenido:**
>>>ID de postulante no encontrado.
>**Contenido:**
El servicio no encontrado.
>>**Codigo:**
>>>500
>**Codigo:**
500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
###Mostrar todos los Postulantes
********
> **URL**
>>/postulantes
___
## Mostrar todos los Postulantes
___
> **Metodo**
>><kbd>GET</kbd>
**URL**
>/postulantes
> **Parametros de la URL**
**Metodo**
><kbd>GET</kbd>
> **Parametros del body**
**Parametros de la URL**
> **Respuesta correcta**
**Parametros del body**
>> **Codigo:**
>>>200
**Respuesta correcta**
>>**Contenido:**
>>>Petición correcta.
> **Codigo:**
200
> **Respuesta de error**
>**Contenido:**
Petición correcta.
>>**Codigo:**
>>>404
**Respuesta de error**
>>**Contenido:**
>>>El servicio no encontrado.
>**Codigo:**
404
>>**Codigo:**
>>>500
>**Contenido:**
El servicio no encontrado.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
>**Codigo:**
500
###Crear registro de Postulante
********
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
> **URL**
>> /postulantes
___
## Crear registro de Postulante
___
> **Metodo**
>><kbd>POST</kbd>
**URL**
> /postulantes
> **Parametros de la URL**
**Metodo**
><kbd>POST</kbd>
> **Parametros del body**
>>
**Parametros de la URL**
**Parametros del body**
>
```json
{
"nombres": "Victor",
......@@ -54,46 +57,48 @@
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
**Respuesta correcta**
> **Codigo:**
201
>**Contenido:**
Registro creado.
>>**Contenido:**
>>>Registro creado.
**Respuesta de error**
> **Respuesta de error**
>**Codigo:**
400
>>**Codigo:**
>>>400
>**Contenido:**
Error en sintaxis de petición.
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Codigo:**
409
>>**Codigo:**
>>>409
>**Contenido:**
Conflicto registro duplicado.
>>**Contenido:**
>>>Conflicto registro duplicado.
>**Codigo:**
500
>>**Codigo:**
>>>500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
___
## Editar datos de Postulante
___
###Editar datos de Postulante
*******
> **URL**
>>/postulantes/
**URL**
>/postulantes/
> **Metodo**
>><kbd>PUT</kbd>
**Metodo**
><kbd>PUT</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
**Parametros de la URL**
><kbd>id</kbd> Postulante
> **Parametros del body**
>>
**Parametros del body**
>
```json
{
"nombres": "Victor Hugo",
......@@ -103,55 +108,57 @@
}
```
> **Respuesta correcta**
**Respuesta correcta**
>**Codigo:**
400
>>**Codigo:**
>>>400
>**Contenido:**
Error en sintaxis de petición.
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Codigo:**
404
>>**Codigo:**
>>>404
>**Contenido:**
ID de postulante no encontrado.
>>**Contenido:**
>>>ID de postulante no encontrado.
>**Codigo:**
500
>>**Codigo:**
>>>500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
___
## Eliminar registro de Postulante
___
###Eliminar registro de Postulante
*******
> **URL**
>>/postulantes/
**URL**
>/postulantes/
> **Metodo**
>><kbd>DELETE</kbd>
**Metodo**
><kbd>DELETE</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
**Parametros de la URL**
><kbd>id</kbd> Postulante
> **Parametros del body**
**Parametros del body**
> **Respuesta correcta**
**Respuesta correcta**
>>**Codigo:**
>>>204
>**Codigo:**
204
>>**Contenido:**
>>>La solicitud se ha completado con exito.
>**Contenido:**
La solicitud se ha completado con exito.
>>**Codigo:**
>>>404
>**Codigo:**
404
>>**Contenido:**
>>>ID de postulante no encontrado.
>**Contenido:**
ID de postulante no encontrado.
>>**Codigo:**
>>>500
>**Codigo:**
500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
###Mostrar Tipos de Dato
********
> **URL**
>>/tipoDato
___
## Mostrar Tipos de Dato
___
> **Metodo**
>><kbd>GET</kbd>
**URL**
>/tipoDatos
> **Parametros de la URL**
**Metodo**
><kbd>GET</kbd>
> **Parametros del body**
**Parametros de la URL**
> **Respuesta correcta**
**Parametros del body**
>> **Codigo:**
>>>200
**Respuesta correcta**
>>**Contenido:**
>>>Petición correcta.
> **Codigo:**
200
> **Respuesta de error**
>**Contenido:**
Petición correcta.
>>**Codigo:**
>>>404
**Respuesta de error**
>>**Contenido:**
>>>El servicio no encontrado.
>**Codigo:**
404
>>**Codigo:**
>>>500
>**Contenido:**
El servicio no encontrado.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
>**Codigo:**
500
###Crear registro para Tipo de Dato
********
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
> **URL**
>> /tipoDato
___
## Crear registro para Tipo de Dato
___
> **Metodo**
>><kbd>POST</kbd>
**URL**
> /tipoDatos
> **Parametros de la URL**
**Metodo**
><kbd>POST</kbd>
> **Parametros del body**
>>
**Parametros de la URL**
**Parametros del body**
>
```json
{
"nombres": "Victor",
"apellidos": "Suarez",
"ci": "45678912",
"sexo": "Masculino"
"propiedad": "WEB",
"nombre": "Pagina web"
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
**Respuesta correcta**
> **Codigo:**
201
>**Contenido:**
Registro creado.
>>**Contenido:**
>>>Registro creado.
**Respuesta de error**
> **Respuesta de error**
>**Codigo:**
400
>>**Codigo:**
>>>400
>**Contenido:**
Error en sintaxis de petición.
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Codigo:**
409
>>**Codigo:**
>>>409
>**Contenido:**
Conflicto registro duplicado.
>>**Contenido:**
>>>Conflicto registro duplicado.
>**Codigo:**
500
>>**Codigo:**
>>>500
>**Contenido:**
La solicitud, no puede ser procesada por el servidor.
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
___
## Editar registro de Tipo de Dato
___
###Editar registro de Tipo de Dato
*******
> **URL**
>>/tipoDato/
**URL**
>/tipoDatos
> **Metodo**
>><kbd>PUT</kbd>
**Metodo**
><kbd>PUT</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
**Parametros de la URL**
><kbd>propiedad</kbd> Tipo Dato
> **Parametros del body**
>>
**Parametros del body**
>
```json
{
"nombres": "Victor Hugo",
"apellidos": "Suarez Perez",
"ci": "45678912",
"sexo": "Masculino"
"propiedad": "WEB",
"nombre": "Página web"
}
```
> **Respuesta correcta**
**Respuesta correcta**
>>**Codigo:**
>>>400
>**Codigo:**
400
>>**Contenido:**
>>>Error en sintaxis de petición.
>**Contenido:**
Error en sintaxis de petición.