Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

1. Exemplo do json:

{
  "id": 123,
  "descricao": "Grupo A",
  "codigo_externo": "123",
  "data_alteracao": "2024-08-30T13:57:02.386Z",
  "ativo": "S"
}

Campos:

  • codigo: Código do registro no banco de dados do CRM

  • descricao: Descrição do grupo;

  • codigo_externo: Código do registro no sistema integrado.

  • data_alteracao: Data da última alteração do registro ( Não deve ser enviado, será preenchido automaticamente ao criar/alterar o registro).

  • ativo: Campo para indicar se a o grupo está ativa (S) ou inativa (N)

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar Grupo pelo código

Endpoint: /pessoa-grupo

Tipo: get

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código do grupo no banco de dados do CRM.

  • codigoExterno: Tipo: String. Código do grupo no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna o grupo no formato documentado na sessão Exemplo do json

2.2 - Buscar todas os grupos

Endpoint: /pessoa-grupo/todos

Tipo: get

Resposta: Status 200 - Retorna a lista dos grupos no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar grupo

Endpoint: /pessoa-grupo

Tipo: post

Notas:

  • Informe no corpo da requisição o json conforme exemplo na sessão 1.

  • Para cadastrar um novo gruponão informe o campo “codigo”;

  • Para editar um grupo já existente informe o campo “codigo” com o código do grupo que deseja editar;

Resposta: Status 200 - Retorna o grupo cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar um grupo

Não é possível deletar um grupo, apenas inativar, pois a grupo pode ter vinculo com pessoas. Nesse caso, o grupo continua no banco de dados porém com o status inativo.

Endpoint: /pessoa-grupo

Tipo: delete

Parâmetros:

  • codigoInterno: Tipo: Inteiro. Código do grupo no banco de dados do CRM.

  • codigoExterno: Tipo: String. Código do grupo no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Mensagem: Registro inativado com sucesso.

2.5 - Retornar os metadados do grupo

Endpoint: /pessoa-grupo/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos do grupo

2.6 - Pesquisar

Endpoint: /pessoa-grupo/pesquisa

Tipo: post

Notas:

  • Esse endpoint retorna os grupos baseados nos filtros e na ordenação informados;

  • Exemplo do corpo da requisição:

  • {
    "pagina": 1,
    "quantidadeRegistros": 5,
    "filtros": [
        {
            "campo": "descricao",
            "comparacao": "CONTEM",
            "valor": "FUNGICIDA"
        }
    ],
    "ordenacao": [
        {
            "campo": "descricao",
            "ordenacao": "ASC"
        }
    ]
}

  • Nesse exemplo, estamos filtrando todas os grupos cuja descrição possua o texto “FUNGICIDA”, também estamos ordenando os registros pela descrição de forma ascendente.

  • No labels