Integración de feriados utilizando la API

Documentación sobre cómo integrar vacaciones, utilizando la API Ronda senior X.

Prerrequisitos generales

• Estar autenticado en Ronda X senior;
• Pase el token en el Header.

Consultar un listado de feriados

• llame al servicioOBTENER /lista de vacaciones consultar la lista de días festivos registrados;
• En el postman debe ser pasado solamente el token: https://sam-api.senior.com.br/api/v1/holidaylist

Registrar un listado de feriados

Para guardar el festivo:

• llame al servicioPOST /lista de vacaciones;
• Pase el JSON en el Cuerpo;
• Ensamble el JSON con los datos de la lista de días festivos, descripción de la lista, descripción del día festivo, indique si el día festivo es recurrente y la fecha del día festivo.

Ejemplos

Ejemplo del Json

{
"id": 0,
"name": "Festivo listado",
"holiday":
[
{
"id": 0,
"name": "Prueba Nombre",
"date": "2017-03-24T03:00:00.000Z",
"recurrent": 0
},
{
"id": 0,
"name": "Prueba Nome2",
"date": "2017-03-24T08:00:00.000Z",
"recurrent": 1
}
]
}

Ejemplo del Json retornado (estado 200)

{
"id": 4,
"name": "Feriado listado",
"holiday":
[
{
"id": 5,
"name": "Teste Nome",
"date": "2017-03-24",
"recurrent": 0
},
{
"id": 6,
"name": "Teste Nome2",
"date": "2017-03-24",
"recurrent": 1
}
]
}

Excluir un listado de festivos

• llame al servicioBORRAR /listadevacaciones/{id};
• En el postman, el id del listado de festivos debe ser pasado por parámetro en la URL: https://sam-api.senior.com.br/api/v1/holidaylist/{listaFeriados}

Si el servicio regresa exitosamente (HTTP 200), no se devolverá ningún JSON.

Alterar un listado de festivos

• llame al servicioPUT /lista de vacaciones;
• Pase el JSON modificado en el cuerpo.

Ejemplo

{
"id": 2,
"name": "Festivo Nacional",
"holiday":
[
{
"id": 0,
"name": "Navidad",
"date": "2017-12-25T10:52:00-03:00",
"recurrent": 1
},
{
"id": 0,
"name": "Año nuevo",
"date": "2017-12-31T10:52:00-03:00",
"recurrent": 1
}
]
}

Si el servicio regresa exitosamente (HTTP 200), no se devolverá ningún JSON.

Informaciones de los servicios

GET /holidaylist

Notas de Implementación

Retornar una matriz de listado de vacaciones

Respuesta Clase (Status 200)

Una matriz de listado de vacaciones

[
{
"id": 0,
"name": "string",
"holiday": [
{
"id": 0,
"name": "string",
"date": "string",
"recurrent": 0
}
]
}
]

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
401	Token es inválido o expirado
500	Error de Servidor	{ "code": 0, "message": "string" }

POST /holidaylist

Notas de Implementación

Cree un nuevo listado de festivos, el campo Id será ignorado

Respuesta Clase (Estado 200)

Creado Listado de Festivos

{
"id": 0,
"name": "string",
"holiday": [
{
"id": 0,
"name": "string",
"date": "string",
"recurrent": 0
}
]
}

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
Listado de Festivos	Listado de Festivos	body	{ "id": 0, "name": "string", "holiday": [ { "id": 0, "name": "string", "date": "string", "recurrent": 0 } ] }

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
401	Token es inválido o expirado
403	Sin permiso para modificar el listado
500	Error de Servidor	{ "code": 0, "message": "string" }

DELETE /holidaylist/{id}

Notas de Implementación

Listado de festivos borrada

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
id	Id del listado de festivos	path	long

Mensajes de Respuesta

HTTP Código Estado	Razón	Modelo de Respuesta
200	Listado de festivos borrada
401	Token es inválido o expirado
403	Operación denegada
404	Listado de Festivos no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }

PUT /holidaylist

Notas de Implementación

Actualizado el listado de festivo

Parámetros

Parámetros	Descripción	Tipo Parámetro	Tipo Fecha
token	Autenticación token	header	string
Listado de Festivos	Listado de Festivos	path	{ "id": 0, "name": "string", "holiday": [ { "id": 0, "name": "string", "date": "string", "recurrent": 0 } ] }

Mensajes de Respuesta

HTTP Codigo Status	Razón	Modelo de Respuesta
200	Listado Festivos actualizada
401	Token es inválido o expirado
403	Sin permiso para modificar el listado
404	Listado de Festivos no encontrada
500	Error de Servidor	{ "code": 0, "message": "string" }