Commit 1e877ea9 authored by D’jalmar Gutierrez Titirico's avatar D’jalmar Gutierrez Titirico 🚲

Merge branch 'iss02-postulante' into 'desarrollo'

Adicionando documentación - Desarrollo de los servicios Postulantes [iss02]

@dgutierrez @gcallejas Se ha agregado documentación en los modelos de Postulantes.

See merge request !7
parents f6b1c213 905c6491
<header class="hero-unit" id="banner">
<div class="container">
<h1>'Allo, 'Allo!</h1>
<p class="lead">Kick-start your next web app with Angular Fullstack</p>
<img src="assets/images/yeoman.png" alt="I'm Yeoman">
<h1>Modulo Personal</h1>
<p class="lead">Parte del Frontend</p>
</div>
</header>
<div class="container">
<div class="row">
<div class="col-lg-12">
<h1 class="page-header">Features:</h1>
<ul class="nav nav-tabs nav-stacked col-md-4 col-lg-4 col-sm-6" ng-repeat="thing in main.awesomeThings">
<li><a href="#" tooltip="{{thing.info}}">{{thing.name}}</a></li>
</ul>
<h1 class="page-header">Caracteristicas:</h1>
</div>
</div>
</div>
<div class="container">
<p>Angular Fullstack v3.3.0 |
<a href="https://twitter.com/tyhenkel">@tyhenkel</a> |
<a href="https://github.com/DaftMonk/generator-angular-fullstack/issues?state=open">Issues</a>
</p>
<p>Angular Fullstack v3.3.0</p>
</div>
......@@ -7,7 +7,7 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="/" class="navbar-brand">modulo-personal</a>
<a href="/" class="navbar-brand">Modulo Personal</a>
</div>
<div collapse="nav.isCollapsed" class="navbar-collapse collapse" id="navbar-main">
<ul class="nav navbar-nav">
......
......@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<base href="/">
<title></title>
<title>Modulo Personal</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width">
<!-- Place favicon.ico and apple-touch-icon.png in the root directory -->
......
###Mostrar todos los Datos de Postulantes
********
> **URL**
>>/datoPostulante
> **Metodo**
>><kbd>GET</kbd>
> **Parametros de la URL**
> **Parametros del body**
> **Respuesta correcta**
>> **Codigo:**
>>>200
>>**Contenido:**
>>>Petición correcta.
> **Respuesta de error**
>>**Codigo:**
>>>404
>>**Contenido:**
>>>El servicio no encontrado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Crear registro para Dato de Postulante
********
> **URL**
>> /postulantes
> **Metodo**
>><kbd>POST</kbd>
> **Parametros de la URL**
> **Parametros del body**
>>
```json
{
"nombres": "Victor",
"apellidos": "Suarez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
>>**Contenido:**
>>>Registro creado.
> **Respuesta de error**
>>**Codigo:**
>>>400
>>**Contenido:**
>>>Error en sintaxis de petición.
>>**Codigo:**
>>>409
>>**Contenido:**
>>>Conflicto registro duplicado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Editar datos Postulante
*******
> **URL**
>>/postulantes/
> **Metodo**
>><kbd>PUT</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
> **Parametros del body**
>>
```json
{
"nombres": "Victor Hugo",
"apellidos": "Suarez Perez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **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**
>>/postulantes/
> **Metodo**
>><kbd>DELETE</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
> **Parametros del body**
> **Respuesta correcta**
>>**Codigo:**
>>>204
>>**Contenido:**
>>>La solicitud se ha completado con exito.
>>**Codigo:**
>>>404
>>**Contenido:**
>>>ID de postulante no encontrado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Mostrar todos los Postulantes
********
Modulo Personal
********
Tipos de Datos
-------------
> **Titulo**
Mostrar todos Tipos de Datos
> **URL**
/tipoDatos
> **URL**
>>/postulantes
> **Metodo**
<kbd>GET</kbd>
>><kbd>GET</kbd>
> **Parametros de la URL**
......@@ -18,69 +12,146 @@ Mostrar todos Tipos de Datos
> **Respuesta correcta**
> **Codigo:** 200
**Contenido:**
>> **Codigo:**
>>>200
>>**Contenido:**
>>>Petición correcta.
> **Respuesta de error**
**Codigo:** 404
**Contenido:** Recurso no encontrado
Guardar Tipos de Datos
-------------
> **Titulo**
Guardar Tipos de Datos
>>**Codigo:**
>>>404
>>**Contenido:**
>>>El servicio no encontrado.
>>**Codigo:**
>>>500
> **URL**
/tipoDatos
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Crear registro de Postulante
********
> **URL**
>> /postulantes
> **Metodo**
<kbd>POST</kbd>
>><kbd>POST</kbd>
> **Parametros de la URL**
> **Parametros del body**
>>
```json
{
"nombre":"Telefono",
"propiedad":"TEL"
"nombres": "Victor",
"apellidos": "Suarez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
> **Codigo:** 200
**Contenido:**
>>**Contenido:**
>>>Registro creado.
> **Respuesta de error**
**Codigo:** 201
**Contenido:** Registro creado.
**Codigo:** 500
**Contenido:** La solicitud contiene sintaxis errónea.
Editar Tipos de Datos
-------------
> **Titulo**
Editar Tipos de Datos
>>**Codigo:**
>>>400
> **URL**
/tipoDatos
>>**Contenido:**
>>>Error en sintaxis de petición.
>>**Codigo:**
>>>409
>>**Contenido:**
>>>Conflicto registro duplicado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Editar datos de Postulante
*******
> **URL**
>>/postulantes/
> **Metodo**
<kbd>PUT</kbd>
>><kbd>PUT</kbd>
> **Parametros de la URL**
<kbd>id</kbd>
>><kbd>id</kbd> Postulante
> **Parametros del body**
>>
```json
{
"nombre":"Telefono",
"propiedad":"TELEFONO"
"nombres": "Victor Hugo",
"apellidos": "Suarez Perez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **Respuesta correcta**
> **Codigo:** 200
**Contenido:**
>>**Codigo:**
>>>400
> **Respuesta de error**
**Codigo:** 400
**Contenido:** La solicitud contiene sintaxis errónea.
>>**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 Postulante
*******
> **URL**
>>/postulantes/
> **Metodo**
>><kbd>DELETE</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
> **Parametros del body**
> **Respuesta correcta**
>>**Codigo:**
>>>204
>>**Contenido:**
>>>La solicitud se ha completado con exito.
>>**Codigo:**
>>>404
>>**Contenido:**
>>>ID de postulante no encontrado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Mostrar Tipos de Dato
********
> **URL**
>>/tipoDato
> **Metodo**
>><kbd>GET</kbd>
> **Parametros de la URL**
> **Parametros del body**
> **Respuesta correcta**
>> **Codigo:**
>>>200
>>**Contenido:**
>>>Petición correcta.
> **Respuesta de error**
>>**Codigo:**
>>>404
>>**Contenido:**
>>>El servicio no encontrado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Crear registro para Tipo de Dato
********
> **URL**
>> /tipoDato
> **Metodo**
>><kbd>POST</kbd>
> **Parametros de la URL**
> **Parametros del body**
>>
```json
{
"nombres": "Victor",
"apellidos": "Suarez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **Respuesta correcta**
>> **Codigo:**
>>>201
>>**Contenido:**
>>>Registro creado.
> **Respuesta de error**
>>**Codigo:**
>>>400
>>**Contenido:**
>>>Error en sintaxis de petición.
>>**Codigo:**
>>>409
>>**Contenido:**
>>>Conflicto registro duplicado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
###Editar registro de Tipo de Dato
*******
> **URL**
>>/tipoDato/
> **Metodo**
>><kbd>PUT</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
> **Parametros del body**
>>
```json
{
"nombres": "Victor Hugo",
"apellidos": "Suarez Perez",
"ci": "45678912",
"sexo": "Masculino"
}
```
> **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 del Tipo de Dato
*******
> **URL**
>>/postulantes/
> **Metodo**
>><kbd>DELETE</kbd>
> **Parametros de la URL**
>><kbd>id</kbd> Postulante
> **Parametros del body**
> **Respuesta correcta**
>>**Codigo:**
>>>204
>>**Contenido:**
>>>La solicitud se ha completado con exito.
>>**Codigo:**
>>>404
>>**Contenido:**
>>>ID de postulante no encontrado.
>>**Codigo:**
>>>500
>>**Contenido:**
>>>La solicitud, no puede ser procesada por el servidor.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment