DELETE

api/genericos/ge/MenuUsuario/ExcluirFavorito

Notas de Implementação:

Excluir um favorito com o valor do ID informado.

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:

ID do favorito a ser excluído.

MenuUsuario

NomeDescriçãoTipoInformação Adicional
NSU

integer

Opcional
CodigoUsuario

string

Opcional
Grupo

string

Opcional
Tipo

string

Opcional
Descricao

string

Opcional
NomeComponenteComando

string

Opcional
Icone

integer

Opcional
Ordem

integer

Opcional

Formato de Envio:

application/json, text/json

Exemplo: 
{
  "NSU": 1,
  "CodigoUsuario": "string 2",
  "Grupo": "string 3",
  "Tipo": "string 4",
  "Descricao": "string 5",
  "NomeComponenteComando": "string 6",
  "Icone": 7,
  "Ordem": 8
}

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:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional
hash

string

Opcional
messages

string

Opcional
data

Object

Opcional
tipoLogin

string

Opcional

Formato de Resposta:

Retorna uma mensagem se teve sucesso ou não para excluir o favorito.

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"
}