- desc

Obtém a lista de colunas da feição. Requisição do tipo GET . No retorno da requisição, as colunas estão no atributo columns e a descrição é dada pela chave alias

Exemplo requisição:

{urlApplication}/{feicao}/desc
						

- get

Obtém registro único de acordo com o fid. Requisição do tipo GET com o único e obrigatório parâmetro fid :

Exemplo requisição:

{urlApplication}/{feicao}/get?fid={fid}
						

- list

Obtém lista de registro das feições. Requisição do tipo GET .

Parâmetros:

					
limit: quantidade de registros que a requisição deve retornar
columns: parâmetro obrigatório. Indica quais colunas da feição a requisição deve retornar. Devem ser separadas por vírgulas.
filter: Filtro com base nas colunas em linguagem SQL
sorter: Ordenação de acordo com colunas. Separadas por vírgulas
				

Exemplo requisição:

{urlApplication}/poste/list?columns=fid,numero,altura&limit=10&sorter=numero&filter=altura > 12
						

O exemplo acima retorna a lista com o fid, o número e a altura de 10 postes com mais de 12 metros, ordenados pelo número.

- count

Obtém a quantidade de registros da feição. Requisição do tipo GET . Possui o parâmetro filter opcional onde pode ser passado um filtro de acordo com a coluna em linguagem SQL.

Exemplo requisição:

{urlApplication}/poste/count?filter=altura=10
						

- delete

Deleta o registro da feição de acordo com o fid. Requisição do tipo POST com o único e obrigatório parâmetro fid :

Exemplo requisição:

{urlApplication}/{feicao}/delete?fid={fid}
						

- save

Insere o registro da feição. Requisição do tipo POST . Os dados a serem salvos devem ser passados no corpo da requisição em um objeto do tipo application/json .

Exemplo requisição:

{urlApplication}/{feicao}/save
						

{urlApplication}/modeloCaixa/list?columns=fid,descricao&filter=fidTipoCaixaEmenda={tipo}
							

{urlApplication}/fabricanteCaixa/list?columns=fid,descricao
							

{urlApplication}/propriedadePoste/list?columns=fid,descricao,indTerceiroObrigatorio
							

{urlApplication}/terceiroPoste/list?columns=fid,nome
							

{urlApplication}/secaoPoste/list?columns=fid,descricao
							

{urlApplication}/materialPoste/list?columns=fid,descricao
							

- Operações com Clientes em Caixas

Os serviços disponíveis para manipular clientes em Caixas (Caixa de Emenda, CTO, Terminador Óptico,CAH e HUB) são: adicionar Cliente (na Caixa); adicionar Conexão (caso o cliente já esteja inserido na Caixa); remover Cliente e sua conexão (se houver); remover apenas a conexão do Cliente; reservar Porta (destinar uma porta de Splitter para um Cliente específico) e atualizar Reserva (atualizar a o status da Conexão de reservada para ativa).

Atributos para operações em Caixas:

- Adicionar Cliente:

Requisição do tipo POST . Os dados a serem salvos devem ser passados no corpo da requisição em um objeto do tipo application/json .

Atributos obrigatórios: fidCliente; fidCaixa ou codigoCaixa e fidTipoCaixa

Atributos opcionais: fidSplitter ou codigoSplitter; numeroPortaSplitter;numeroPortaCliente

Se os parâmetros opcionais não forem passados, o Cliente é adicionado na Caixa, mas sem a criação de uma Conexão.

Caso os parametros relacionados a criação da conexão seja passado e o numero da porta do Cliente não, a conexão será realizada na porta 0 do cliente.

Requisição:

{urlApplication}/fusoesCaixa/inserirCliente
						

- Adicionar Conexão:

Requisição do tipo POST . Os dados a serem salvos devem ser passados no corpo da requisição em um objeto do tipo application/json .

Atributos obrigatórios: fidCliente

Atributos opcionais: fidSplitter ou codigoSplitter; numeroPortaSplitter; numeroPortaCliente

Se os parâmetros relacionados ao Splitter não forem passados, a Conexão é criada automaticamente na primeira porta de Splitter de atendimento disponível. Se o numero da porta do Cliente não for passado, a conexão será criada na porta 0 do cliente.

Requisição:

{urlApplication}/fusoesCaixa/adicionarConexao
						

- Remover Cliente:

Requisição do tipo POST . O Fid do Cliente deve ser passado como parâmetro na URL da requisição.

Requisição:

{urlApplication}/fusoesCaixa/removerCliente?fidCliente={fidCliente}
						

- Remover Conexão do Cliente:

Requisição do tipo POST . O Fid do Cliente deve ser passado como parâmetro na URL da requisição.

Requisição:

{urlApplication}/fusoesCaixa/removerConexaoCliente?fidCliente={fidCliente}
						

- Reservar Porta:

Requisição do tipo POST . Os dados a serem salvos devem ser passados no corpo da requisição em um objeto do tipo application/json .

Atributos obrigatórios: fidCliente; fidCaixa

Atributos opcionais: fidSplitter; numeroPortaSplitter

Se os parâmetros opcionais não forem passados, a Reserva é efetuada automaticamente na primeira porta de Splitter de atendimento disponível.

Requisição:

{urlApplication}/fusoesCaixa/reservarPorta
						

Resposta:

porta: número da porta em que a reserva foi feita
fidSplitter: identificação do splitter
fidConexão: identificação da conexão criada
dataExpiracao: data (no formato 'dd/MM/aaaa HH:mm:ss') em que a reserva expira

- Update da Reserva:

Requisição do tipo POST . Os Fid's do Cliente e da Caixa devem ser passados como parâmetro na URL da requisição.

Requisição:

{urlApplication}/fusoesCaixa/updateReserva?fidCliente={fidCliente}&fidCaixa={fidCaixa}
						

- Listar notas:

Requisição do tipo GET . O fid do tipo de feição e o fid da caixa devem ser passados na URL da requisição.

Requisição:

{urlApplication}/nota/list?columns=fid,texto&limit=10&sorter=texto&filter=fidTipoFeicaoEsquematico=87%AND%fidFeicaoEsquematico={fidCaixa}
						

- Listar clientes conectados ao splitter:

Requisição do tipo GET . O tipo de splitter: 1 – Atendimento e 2 – Distribuição e o status da conexão: 0 - sem reserva e 1 - reservado devem ser informados.

Requisição:

{urlApplication}/splitterCliente/list?columns=nome&limit=10&sorter=nome&filter=tipoSplitter=1%AND%reservado=1%AND%fidSplitter={fidSplitter}
						

- Operações com Splitter

O serviço disponível para manipular splitter funciona como cadastro e edição.

Atributos para operações em Splitter:

- Salvar ou alterar splitter:

Requisição do tipo POST . Os dados a serem salvos devem ser passados no corpo da requisição em um objeto do tipo application/json .

Atributos obrigatórios: fidModeloSplitter, fidTipoFeicaoInstalacao, fidFeicaoInstalacao e fidTipo

Atributos opcionais: indBalanceado, indConectorizado e fidModeloSplitter

Se os parâmetros opcionais não forem informados, o valor no banco ficará como 0.

Requisição:

{urlApplication}/splitter/save
						

Tabelas:

Viabilidade Técnica

- Consulta de Caixas:

Requisição do tipo GET . Os parâmetros devem ser passados na URL.

Atributos:

Exemplo requisição:

{urlApplication}/viabilidade/caixas?raio=200&endereco=Rua tomé de souza, 845, funcionários, BH - MG
						

O retorno será uma lista de caixas que estão dentro raio com os seguintes atributos:

- Consulta de Caixas com rotas sugeridas:

Requisição do tipo GET . Os parâmetros devem ser passados na URL.

Atributos:

Exemplo requisição:

{urlApplication}/viabilidade/caixasRotasSugeridas?raio=200&endereco=Rua tomé de souza, 845, funcionários, BH - MG&qtdRotas=5
						

O retorno será uma lista de caixas que estão dentro raio com os seguintes atributos:

- Distância da rota sugerida:

Requisição do tipo GET . Os parâmetros devem ser passados na URL.

Atributos:

Exemplo requisição:

{urlApplication}/viabilidade/distanciaRotaSugerida?fidCaixa=216981&fidCliente=2162
						

O retorno será uma rota sugerida entre a caixa e o cliente com os seguintes atributos:

- Facilidade:

Requisição do tipo GET . Os parâmetros devem ser passados na URL.

Atributos:

Exemplos requisições:

{urlApplication}/viabilidade/facilidade?raio=100&endereco=Avenida Bias Fortes&latitude=-19.930691478687518&longitude=-43.940275216627946
						

{urlApplication}/viabilidade/facilidade?raio=100&latitude=-19.930691478687518&longitude=-43.940275216627946
						

{urlApplication}/viabilidade/facilidade?raio=100&latitude=-19.930691478687518&longitude=-43.940275216627946&cto=1&caixaEmenda=1
						

O retorno será uma lista de caixas e estações que estão dentro raio com os seguintes atributos:

Elementos Excluídos

- Consulta de feicões:

Requisição do tipo GET . Os parâmetros devem ser passados na URL.

Atributos:

Exemplo requisição:

{urlApplication}/elementoExcluido/get?sorter=datahoraExclusao&direction=desc&dataInicial=2024-01-18&dataFinal=2024-01-19
						

O retorno será uma lista das feicoes que foram excluídas: Caso não seja passado nenhum parâmetro o retorno será uma lista de todas as feicoes que foram excluídas: