Integração de feriados utilizando a API

Documentação de como realizar a integração dos feriados, utilizando a API do Ronda senior X.

Pré-requisitos gerais

• Estar autenticado no Ronda senior X;
• Passar o token no Header.

Consultar uma lista de feriados

• Chame o serviço GET /holidaylist para consultar a lista de feriados cadastrados;
• No postman deve ser passado apenas o token: https://sam-api.senior.com.br/api/v1/holidaylist

Cadastrar uma lista de feriados

Para salvar o feriado:

• Chame o serviço POST /holidaylist;
• Passe no Body o JSON;
• Monte o JSON com os dados da lista de feriado, descrição da lista, descrição do feriado, indique se o feriado é recorrente e a data do feriado.

Exemplos

Exemplo do Json

{
  "id": 0,
  "name": "Feriado lista",
  "holiday":
  [
    {
      "id": 0,
      "name": "Teste Nome",
      "date": "2017-03-24T03:00:00.000Z",
      "recurrent": 0
    },
    {
      "id": 0,
      "name": "Teste Nome2",
      "date": "2017-03-24T08:00:00.000Z",
      "recurrent": 1
    }
  ]
}

Exemplo do Json retornado (status 200)

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

Excluir uma lista de feriados

• Chame o serviço DELETE /holidaylist/{id};
• No postman, o id da lista de feriados deve ser passado por parâmetro na URL: https://sam-api.senior.com.br/api/v1/holidaylist/{listaFeriados}

Se o retorno do serviço tiver êxito (HTTP 200), não haverá JSON de retorno.

Alterar uma lista de feriados

• Chame o serviço PUT /holidaylist;
• Passe no body o JSON modificado.

Exemplo

{
  "id": 2,
  "name": "Feriado Nacional",
  "holiday":
  [
    {
      "id": 0,
      "name": "Natal",
      "date": "2017-12-25T10:52:00-03:00",
      "recurrent": 1
    },
    {
      "id": 0,
      "name": "Ano novo",
      "date": "2017-12-31T10:52:00-03:00",
      "recurrent": 1
    }
  ]
}

Se o retorno do serviço tiver sucesso (HTTP 200), não haverá JSON de retorno.

Informações dos serviços

GET /holidaylist

Implementation Notes

Return a array of holiday list

Response Class (Status 200)

A array of holiday list

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
500	Server error	{   "code": 0,   "message": "string" }

POST /holidaylist

Implementation Notes

Create a new Holiday list, Id field will be ignored

Response Class (Status 200)

Holiday list created

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

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
Holiday list	Holiday list	body	{   "id": 0,   "name": "string",   "holiday": [     {       "id": 0,       "name": "string",       "date": "string",       "recurrent": 0     }   ] }

Response Messages

HTTP Status Code	Reason	Response Model
401	Token is invalid or expired
403	No permission to modify the list
500	Server error	{   "code": 0,   "message": "string" }

DELETE /holidaylist/{id}

Implementation Notes

Delete a holiday list

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
id	Id of holiday list	path	long

Response Messages

HTTP Status Code	Reason	Response Model
200	Holiday list deleted
401	Token is invalid or expired
403	Operation denied
404	Holiday list not found
500	Server error	{   "code": 0,   "message": "string" }

PUT /holidaylist

Implementation Notes

Update a holiday list

Parameters

Parameter	Description	Parameter Type	Data Type
token	Authentication token	header	string
Holiday list	Holiday list	path	{   "id": 0,   "name": "string",   "holiday": [     {       "id": 0,       "name": "string",       "date": "string",       "recurrent": 0     }   ] }

Response Messages

HTTP Status Code	Reason	Response Model
200	Holiday list updated
401	Token is invalid or expired
403	No permission to modify the list
404	Holiday list not found
500	Server error	{   "code": 0,   "message": "string" }