POST

api/genericos/ge/Alerta/Salvar

Notas de Implementação:

Método para salvar um alerta para um usuário escolhido passando AlertaDTO.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Modelo:

Propriedades com as informações do alerta a serem criados.

AlertaDTO

NomeDescriçãoTipoInformação Adicional
IdAlerta

Informa o ID do alerta. O valor deve ser único.

 integer

Obrigatório

Somente enviar se for alteração, não enviar se for inclusão
Titulo

Título do alerta.

 string

Opcional
Assunto

Assunto/informação do alerta.

 string

Obrigatório
DataAlerta

Data do alerta. Deve ser maior ou igual a data atual.

 string

Obrigatório

Formato: DD/MM/YYYY
HoraAlerta

Hora do alerta.

 string

Obrigatório

Formato: HH:MM:SS
LembrarEm

Define o tempo para lembrar novamente após adiar o alerta.

 string

Obrigatório

Tamanho Máximo: 2

Faixa: 01 a 15
DataAviso

Data de aviso do alerta. Deve ser maior ou igual a data atual.

 string

Obrigatório

Formato: DD/MM/YYYY
HoraAviso

Hora de aviso do alerta.

 string

Obrigatório

Formato: HH:MM:SS
Recorrencia

Define se a recorrência será diária ou semanal.

 string

Obrigatório

Tamanho Único: 1

Faixa: "D" = Diária, "S" = Semanal
NumeroDiasOuSemanas

Define o número de dias ou semanas do alerta.

 integer

Obrigatório

Tamanho: entre 1 e 99
Domingo

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
SegundaFeira

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
TercaFeira

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
QuartaFeira

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
QuintaFeira

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
SextaFeira

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
Sabado

Define o dia da semana em que o alerta será disparado. Quando a recorrência é semanal é obrigatório definir pelo menos um dia da semana.

 boolean

Opcional
NumeroOuDataTermino

Define se o término será realizado a partir de um número de dias ou uma data de término.

 string

Obrigatório

Tamanho Único: 1

Faixa: "N" = Número de dias, "D" = Data de término
NumeroTerminoApos

Define o número de ocorrências do alerta. Obrigatório se NumeroOuDataTermino for igual a "N".

 integer

Obrigatório

Tamanho: entre 1 e 99
DataTerminoEm

Define a data de término. Obrigatório se NumeroOuDataTermino for igual a "D".

 string

Obrigatório

Formato: DD/MM/YYYY
Concluido

Define se o alerta está concluído.

 string

Obrigatório

Tamanho Único: 1

Faixa: "S" = Sim, "N" = Não, "D" = Descartado
UsuariosSiglas

Lista de códigos de usuários definidos para receber o alerta.

 string

Obrigatório
Url

Define a url a ser aberta pelo alerta.

 string

Opcional

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "IdAlerta": 1,
  "Titulo": "string 2",
  "Assunto": "string 3",
  "DataAlerta": "string 4",
  "HoraAlerta": "",
  "LembrarEm": "string 6",
  "DataAviso": "string 7",
  "HoraAviso": "",
  "Recorrencia": "string 9",
  "NumeroDiasOuSemanas": 10,
  "Domingo": true,
  "SegundaFeira": true,
  "TercaFeira": true,
  "QuartaFeira": true,
  "QuintaFeira": true,
  "SextaFeira": true,
  "Sabado": true,
  "NumeroOuDataTermino": "string 18",
  "NumeroTerminoApos": 19,
  "DataTerminoEm": "string 20",
  "Concluido": "string 21",
  "UsuariosSiglas": [
    "string 1"
  ],
  "Url": "string 22"
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

Informações das propriedades de retorno.

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Objeto JSON com lista dos dados referente ao alerta criado.

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo: 
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
401 Não autorizado

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
500 Requisição falhou

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{ 
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"
}