Adicionar
POST {{url}}/api/v1/integracao/configuracao/alerta
POST
No método POST, será possível adicionar alertas e obter o retorno no formato JSON como resposta. Os seguintes parâmetros podem/devem ser utilizados:
| Atributo | Descrição | Obrigatório |
|---|---|---|
| descricao | Descrição do alerta | Sim |
| visivelviaapi | Indica se estará disponivel via API | Sim |
| atendimento | Indica se o alerta estará disponivel na abertura de atendimentos | Sim |
| cidade | Array de cidades (pode conter os bairros também) | Não |
| grupo_cliente | Array de grupos de cliente | Não |
| grupoclienteservico | Array de grupos de serviço | Não |
| interface_conexao | Array de interfaces de conexão | Não |
| servico_status | Array de status do serviço | Não |
| caixa_optica | Array de caixas opticas | Não |
| pops | Array de pops | Não |
| data_inicio | Data de início do alerta | Não |
| data_fim | Data de fim do alerta | Não |
Os atributos podem conter os seguintes valores:
| Atributo | Descrição | Valor Default |
|---|---|---|
| descrição | Campo Livre (Qualquer valor é aceito) | Nenhum |
| visivelviaapi | Booleano (true/false) | Nenhum |
| atendimento | Booleano (true/false) | Nenhum |
| cidade | Array de objetos contendo (id_cidade) e opcionalmente um array de bairros (contendo o nome do bairro) | Nenhum |
| grupo_cliente | Array de objetos contendo (idgrupocliente) | Nenhum |
| grupoclienteservico | Array de objetos contendo (id) | Nenhum |
| interface_conexao | Array de objetos contendo (idinterfaceconexao) | Nenhum |
| caixa_optica | Array de objetos contendo (idcaixaoptica) | Nenhum |
| servico_status | Array de objetos contendo (idservicostatus) | Nenhum |
| pops | Array de objetos contendo (id_pop) | Nenhum |
| data_inicio | Date (YYYY-MM-DD) | Nenhum |
| data_fim | Date (YYYY-MM-DD) | Nenhum |
Request Body
{"descricao"=>"ALERTA TESTE CADASTRO API", "visivel_via_api"=>true, "atendimento"=>true, "cidade"=>[{"id_cidade"=>6976, "bairros"=>[{"nome"=>"TESTE"}]}], "grupo_cliente"=>[{"id_grupo_cliente"=>46}], "grupo_cliente_servico"=>[{"id"=>22}], "interface_conexao"=>[{"id_interface_conexao"=>1478}], "caixa_optica"=>[{"id_caixa_optica"=>1221}], "servico_status"=>[{"id_servico_status"=>9}], "data_inicio"=>"2023-08-09", "data_fim"=>"2023-08-10", "hora_inicio"=>"09:15", "hora_fim"=>"16:48"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | Bearer Token obtido na autenticação |
RESPONSES
status: OK
{"status":"success","msg":"Alerta cadastrado com sucesso!","alerta":[{"id_alerta":1,"descricao":"ALERTA TESTE CADASTRO API","ativo":true,"data_cadastro":"21/08/2023 15:49","data_inicio":null,"data_fim":null,"texto_alerta":"ALERTA TESTE CADASTRO API\n\n21/08/2023 15:49 - Usuário API\n","cidade":[],"grupo_cliente":[],"grupo_cliente_servico":[],"interface_conexao":[],"caixa_optica":[],"servico_status":[],"pops":[{"id_pop":53,"descricao":"DEV TESTE - API"}],"usuario":{"id":1,"nome":"Usuário API"}}]}