Advise Plataforma - Open API
APIs REST para a plataforma Advise.
Cada API da Advise fornece, de forma fácil e objetiva, seus métodos suportados, campos retornados, obrigatoriedade de informações, tal como suas situações e resultados.
Todas as APIs encontram-se divididas de acordo com a sua funcionalidade e métodos.
| Contato | |
| Telefone: (43) 3339-1000 | |
| Email: gislene.koyama@advise.com.br |
Navegação
A organização das pastas foi feita com a intenção de agrupar os assuntos em Documentação, Operações e Models.
Na pasta Documentação, irá constar as informações sobre a Empresa, manuais de utilização e informações mais genéricas.
Na pasta Models, irá constar os DTOs.
A pasta Operações está organizada em Assuntos\APIs\Rotas
Sempre que clicar em um Assunto, vai mostrar as regras e informações
- Ás páginas funcionam de forma sequencial, então conforme vai descendo a página irá mostrando os próximos assuntos e rotas.
Try It Out (Testar Rota)
Toda rota irá ter esse botão.
Na tela que abrir, selecionar os parâmetros em ‘Request Params’, conforme for marcando irá mostrando no lado esquerdo em Query Parameters.
Informar os parâmetros e clicar em SUBMIT.
POST
/core/v1/processos-clientes
GET
/core/v1/processos-clientes/fontes-processos
GET
/core/v1/cabecalhos-processos
POST
/core/v1/processos-clientes/anexos
PUT
/core/v1/processos-clientes/alterar-situacao
PUT
/core/v1/processos-clientes/excluir-fonte
GET
/core/v1/processos-clientes/dados-numero-processo
POST
/core/v1/processos-clientes/dados-lista-numero-processo
GET
/core/v1/anexo-fonte-processo/
{id}
GET
/core/v1/processos-clientes/andamentos
GET
/core/v1/processos-clientes/sujeitos
GET
/core/v1/processos-clientes/informacoes-adicionais
GET
/core/v1/processos-clientes/processos-relacionados
PUT
/core/v1/processos-clientes/marcar-lidos
PUT
/core/v1/processos-clientes/desmarcar-lidos
POST
/core/v1/processos-clientes
Exemplo:
POST /processos
{
"itens": [
{
"idUsuarioCliente": 51344,
"idUsuarioInclusao": 1,
"processos": [
{
"nomePasta": "Teste Nome Pasta",
"idSitPesqProcUsuarioCliente": 123,
"numeroProcesso": "0023382-29.2001.8.26.7155",
"FlNumUnicaCNJ" : true,
"fontesPesquisa": [
{
"idFonteXTipoPesquisa": 220,
"idValorParamFonteProc": 2308
}
]
}
]
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
Default:
{
"itens": [
{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}
]
}itens
Array
Object
Default:
{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
ativo
boolean
flPesqAndamentoAuto
boolean
required
flPesqPublicacaoAuto
boolean
required
idUsuarioClienteXFuncionalidade
integer
int64
required
flDonoProcesso
boolean
idSitPesqProcUsuarioCliente
integer
int64
required
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
processos
Array
Object
id
integer
int64
numeroProcesso
string
required
idTipoNumeroProcesso
integer
int64
flNumUnicaCNJ
boolean
required
solicPrimVezCliente
boolean
nomePasta
string
idSitPesqProcUsuarioCliente
integer
int64
fontesPesquisa
Array
Object
id
integer
int64
required
idProcesso
integer
int64
idFonteXTipoPesquisa
integer
int64
idValorParamFonteProc
integer
int64
flSolicPorPublic
boolean
required
ativo
boolean
clienteXFontePesqProcDTO
Array
Object
idCliente
integer
int64
required
idFontePesqProcesso
integer
int64
required
idLoteProcSpiderUltSuces
integer
int64
idLoteProcSpiderUltAgend
integer
int64
ativo
boolean
flSolicErroSpider
boolean
pesqProcUsuarioCliente
Array
Object
id
integer
int64
required
idClienteXFontePesProc
integer
int64
required
flPesqAndamentoAuto
boolean
required
flPesqPublicacaoAuto
boolean
required
idUsuarioClienteXFuncionalidade
integer
int64
required
idSitPesqProcUsuarioCliente
integer
int64
required
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
dataHoraUltSolic
string
date-time
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
GET
/core/v1/processos-clientes/fontes-processos
Request parameters
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdUsuarioClienteXFuncionalidade
integer
int64
optional
IdFonteXTipoPesquisa
integer
int64
optional
IdValorParamFontePesq
integer
int64
optional
IdClassificacaoRetorno
integer
int64
optional
IdProcesso
integer
int64
optional
IdsSituacoes
string
optional
NumeroProcesso
string
optional
IdOrgao
integer
int64
optional
SiglaOrgao
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/cabecalhos-processos
Request parameters
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdFonteProcesso
integer
int64
optional
IdFontePesquisaProcesso
integer
int64
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/processos-clientes/anexos
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
fontesProcesso
Array
Object
idFonteProcesso
integer
int64
idProcesso
integer
int64
idFonte
integer
int64
idParametro
integer
int64
trazerAnexosAndamento
boolean
pagina
integer
int32
registrosPagina
integer
int32
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
PUT
/core/v1/processos-clientes/alterar-situacao
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
flAtivo
boolean
pesqProcAltSituacao
Array
Object
numeroProcesso
string
idFonteXTipoPesquisa
integer
int64
idValorParamFonteProc
integer
int64
idPesqProcUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/processos-clientes/excluir-fonte
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idGrupoUsuarios
integer
int64
fonteParamPesqProcesso
Array
Object
numeroProcesso
string
idFonteXTipoPesquisa
integer
int64
idValorParamFonteProc
integer
int64
idPesqProcUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/dados-numero-processo
Request parameters
NumeroProcesso
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/processos-clientes/dados-lista-numero-processo
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaNumeroProcesso
Array
of
string
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
GET
/core/v1/anexo-fonte-processo/
{id}Path variables
id
integer
int64
required
Request parameters
idUsuarioCliente
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/andamentos
Request parameters
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
Lidos
boolean
optional
MarcarLido
boolean
optional
DataInicial
string
date-time
optional
DataFinal
string
date-time
optional
IdProcesso
string
optional
NumeroProcesso
string
optional
IdFonteProcesso
integer
int64
optional
DataCadastro
string
date-time
optional
FlTrazerAnexos
boolean
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/sujeitos
Request parameters
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdFonteXTipoPesquisa
integer
int64
optional
IdValorParamFonteProc
integer
int64
optional
IdProcesso
string
optional
NumeroProcesso
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/informacoes-adicionais
Request parameters
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdProcesso
string
optional
NumeroProcesso
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/processos-relacionados
Request parameters
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdProcesso
string
optional
NumeroProcesso
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/processos-clientes/marcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/processos-clientes/desmarcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes
GET
/core/v1/publicacoes-clientes/
{id}
PUT
/core/v1/publicacoes-clientes/
{id}/marcar-lido
PUT
/core/v1/publicacoes-clientes/marcar-lidos
PUT
/core/v1/publicacoes-clientes/desmarcar-lidos
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/palavras-chaves
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/palavras-chaves/{id}
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/processos
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/processos/{id}
GET
/core/v1/publicacoes-clientes/consulta-paginada
GET
/core/v1/publicacoes-clientes
Request parameters
IdsProcessoPublicacao
string
optional
IdsPublClientePalChave
string
optional
DataInicioPublicacao
string
date-time
optional
DataFimPublicacao
string
date-time
optional
IdsDiarios
string
optional
IdsMovProcUsuarioCliente
string
optional
IdsPalavrasChaves
string
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdCliente
integer
int64
optional
Lido
boolean
optional
Ativo
boolean
optional
DataInicioMovimento
string
date-time
optional
DataFimMovimento
string
date-time
optional
IdsCadernosDiarios
string
optional
DataCadastro
string
date-time
optional
Id
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{id}Path variables
id
integer
int64
required
Request parameters
idClienteMovimento
integer
int64
optional
idUsuarioClienteMovimento
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/
{id}/marcar-lidoEsta ação não requer o envio de nenhum dado.
Path variables
id
integer
int64
required
Request parameters
idUsuarioClienteMovimento
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/marcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/desmarcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/palavras-chavesPath variables
idPublicacaoCliente
integer
int64
required
Request parameters
IdPublicacaoCliente
string
optional
Id
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/palavras-chaves/{id}Path variables
idPublicacaoCliente
integer
int64
required
id
integer
int64
required
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/processosPath variables
idPublicacaoCliente
integer
int64
required
Request parameters
IdPublicacaoCliente
string
optional
Id
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{idPublicacaoCliente}/processos/{id}Path variables
idPublicacaoCliente
integer
int64
required
id
integer
int64
required
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/consulta-paginada
Request parameters
IdsProcessoPublicacao
string
optional
IdsPublClientePalChave
string
optional
DataInicioPublicacao
string
date-time
optional
DataFimPublicacao
string
date-time
optional
IdsDiarios
string
optional
IdsMovProcUsuarioCliente
string
optional
IdsPalavrasChaves
string
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdCliente
integer
int64
optional
Lido
boolean
optional
Ativo
boolean
optional
DataInicioMovimento
string
date-time
optional
DataFimMovimento
string
date-time
optional
IdsCadernosDiarios
string
optional
DataCadastro
string
date-time
optional
Id
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/palavras-chaves
GET
/core/v1/palavras-chaves/
{IdPalavraChave}
PUT
/core/v1/palavras-chaves
POST
/core/v1/palavras-chaves
PUT
/core/v1/palavras-chaves/aprovar
PUT
/core/v1/palavras-chaves/reprovar
PUT
/core/v1/palavras-chaves/ativar
PUT
/core/v1/palavras-chaves/inativar
GET
/core/v1/palavra-chave-cliente/consultar
POST
/core/v1/palavra-chave-cliente/inserir
PUT
/core/v1/palavra-chave-cliente/alterar-situacao
PUT
/core/v1/palavra-chave-cliente/alterar-situacao-variacao
PUT
/core/v1/palavra-chave-cliente/atualizar
GET
/core/v1/palavra-chave-cliente/consultar
Request parameters
IdCliente
integer
int64
optional
IdPalavraChave
string
optional
IdPalavraChavePrincipal
integer
int64
optional
IdTipoPalavraChave
integer
int64
optional
IdSituacaoPalavraChave
string
optional
IdUsuarioClienteDono
integer
int64
optional
IdGrupoUsuariosDono
integer
int64
optional
FlPalavraChaveExata
boolean
optional
NomePalavraChave
string
optional
DataHoraInclusao
string
date-time
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Limitado
boolean
optional
ConsultaParceiros
boolean
optional
IdParceiro
integer
int64
optional
IdTipoUsuario
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/palavra-chave-cliente/inserir
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaPalavraChave
Array
Object
palavraChave
string
idTipoPalavraChave
integer
int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
palavraChavePrincipal
string
idClassifPalavraChave
integer
int64
idCliente
integer
int64
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
idSituacaoPalavraChave
integer
int64
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
PUT
/core/v1/palavra-chave-cliente/alterar-situacao
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer
int64
idSituacaoPalavraChave
integer
int64
motivoSituacaoPalavraChave
string
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavra-chave-cliente/alterar-situacao-variacao
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer
int64
flStatus
boolean
motivoSituacaoPalavraChave
string
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavra-chave-cliente/atualizar
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idPalavraChave
integer
int64
palavraChave
string
idTipoPalavraChave
integer
int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/palavras-chaves
Exemplo:
GET /palavras-chaves/?campos=IdDiario,nomeUsuarioInclusaoRequest parameters
DataInicio
string
date-time
optional
DataFim
string
date-time
optional
Cliente
integer
int32
optional
UsuarioCliente
integer
int32
optional
IdCliente
integer
int32
optional
IdUsuarioCliente
integer
int32
optional
IdsPalavraChavePrincipal
string
optional
IdsTipoPalavraChave
string
optional
Diario
integer
int32
optional
Situacao
integer
int32
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Coluna
string
optional
Ordem
string
optional
Limitado
boolean
optional
NomePalavraChave
string
optional
IDs
string
optional
Campos
string
optional
Expansao
string
optional
Q
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
GET
/core/v1/palavras-chaves/
{IdPalavraChave}Path variables
IdPalavraChave
integer
int64
required
Request parameters
IDsPalavraChave
string
optional
IdContrato
string
optional
IdPlano
string
optional
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdsSituacaoPalavraChave
string
optional
IdTipoPalavraChave
string
optional
Ativo
boolean
optional
NomePalavraChave
string
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavras-chaves
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
palavraChave
string
required
idTipoPalavraChave
integer
int64
palavraChaveExata
boolean
idContrato
integer
int64
idPlano
integer
int64
usuariosCliente
Array
Object
idUsuarioClienteXPalChave
integer
int64
required
idUsuarioClienteXFuncionalidade
integer
int64
ativo
boolean
id
integer
int64
vincularTodosDiarios
boolean
diarios
Array
required
Object
idDiario
integer
int64
required
ativo
boolean
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/palavras-chaves
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
palavraChave
string
required
idTipoPalavraChave
integer
int64
required
idPalavraChavePrincipal
integer
int64
palavraChaveExata
boolean
ativo
boolean
idContrato
integer
int64
idPlano
integer
int64
usuariosCliente
Array
Object
id
integer
int64
idUsuarioClienteXFuncionalidade
integer
int64
ativo
boolean
vincularTodosDiarios
boolean
diarios
Array
required
Object
idDiario
integer
int64
required
ativo
boolean
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
PUT
/core/v1/palavras-chaves/aprovar
PUT /palavras-chaves/aprovar
body: { “ids”: [32,33] }
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavras-chaves/reprovar
PUT /palavras-chaves/aprovar
"id": 32,
"motivo": Cancelei,
"idUsuarioCancelamento": 10Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
id
integer
int64
motivo
string
idUsuarioCancelamento
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavras-chaves/ativar
PUT /palavras-chaves/ativar
body: { “ids”: [32,33] }
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavras-chaves/inativar
PUT /palavras-chaves/inativar
body: { “ids”: [32,33] }
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/tipos-palavra-chave
GET
/core/v1/tipos-palavra-chave
Exemplo: /tipos-palavra-chave
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
PUT
/core/v1/palavras-chaves/desfazer-recusa
PUT
/core/v1/palavras-chaves/desfazer-aprovacao
GET
/core/v1/situacoes-palavra-chave
PUT
/core/v1/palavras-chaves/desfazer-recusa
PUT /palavras-chaves/desfazer-recusa
Este método retorna a situação da palavra chave para ‘Pendente’
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/palavras-chaves/desfazer-aprovacao
PUT /palavras-chaves/desfazer-aprovacao
Este método retorna a situação da palavra chave para ‘Pendente’
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/situacoes-palavra-chave
Exemplo: /situacoes-palavra-chave
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
GET
/core/v1/usuario-cliente-palavras-chaves/
{ids}/diarios-usuarios
GET
/core/v1/usuario-cliente-palavras-chaves
POST
/core/v1/usuario-cliente-palavras-chaves
PUT
/core/v1/usuario-cliente-palavras-chaves
PUT
/core/v1/usuario-cliente-palavras-chaves/ativar
PUT
/core/v1/usuario-cliente-palavras-chaves/inativar
DELETE
/core/v1/usuario-cliente-palavras-chaves/
{id}
GET
/core/v1/usuario-cliente-palavras-chaves/
{id}/diarios
PUT
/core/v1/usuario-cliente-palavras-chaves/adicionar-diarios
PUT
/core/v1/usuario-cliente-palavras-chaves/
{id}/diarios/ativar
PUT
/core/v1/usuario-cliente-palavras-chaves/
{id}/diarios/inativar
GET
/core/v1/usuario-cliente-palavras-chaves/
{ids}/diarios-usuariosPath variables
ids
string
required
Request parameters
IDsUsarioClienteXPalChave
string
optional
IDsUsarioClienteXDiario
string
optional
Ativo
boolean
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/usuario-cliente-palavras-chaves
Request parameters
IDsPalavraChave
string
optional
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdsSituacaoPalavraChave
string
optional
IdTipoPalavraChave
string
optional
Ativo
boolean
optional
NomePalavraChave
string
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/usuario-cliente-palavras-chaves
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioClienteXDiario
integer
int64
palavraChave
Object
id
integer
int64
idClienteXDiario
integer
int64
palavraChave
string
required
idPalavraChave
integer
int64
dataHoraInclusao
string
date-time
idTipoPalavraChave
integer
int64
required
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
idSituacaoPalavraChave
integer
int64
nomePessoaCliente
string
idCliente
integer
int64
required
nomePessoaUsuarioCliente
string
idUsuarioCliente
integer
int64
nomePlano
string
idPlano
integer
int64
nomeTipoPlano
string
idTipoPlano
integer
int64
tipoPalavra
string
situacao
string
dataHoraUltAlteracao
string
date-time
idContrato
integer
int64
numeroContrato
string
idDiario
integer
int64
required
nomeDiario
string
idUsuarioInclusao
integer
int64
nomeUsuarioInclusao
string
idUsuarioUltAlteracao
integer
int64
nomeUsuarioUltAlteracao
string
diasRetroativa
integer
int64
flMigracao
boolean
nomePlanoBase
string
flAtivo
boolean
idUsuarioClienteXFuncionalidade
integer
int64
flDonoPalavraChave
integer
int64
vincularTodosDiarios
boolean
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioAlteracao
integer
int64
dataHoraUlAlteracao
string
date-time
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
201
201
Retorna a lista de objetos inseridos.
PUT
/core/v1/usuario-cliente-palavras-chaves
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioClienteXDiario
integer
int64
palavraChave
Object
id
integer
int64
idClienteXDiario
integer
int64
palavraChave
string
required
idPalavraChave
integer
int64
dataHoraInclusao
string
date-time
idTipoPalavraChave
integer
int64
required
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
idSituacaoPalavraChave
integer
int64
nomePessoaCliente
string
idCliente
integer
int64
required
nomePessoaUsuarioCliente
string
idUsuarioCliente
integer
int64
nomePlano
string
idPlano
integer
int64
nomeTipoPlano
string
idTipoPlano
integer
int64
tipoPalavra
string
situacao
string
dataHoraUltAlteracao
string
date-time
idContrato
integer
int64
numeroContrato
string
idDiario
integer
int64
required
nomeDiario
string
idUsuarioInclusao
integer
int64
nomeUsuarioInclusao
string
idUsuarioUltAlteracao
integer
int64
nomeUsuarioUltAlteracao
string
diasRetroativa
integer
int64
flMigracao
boolean
nomePlanoBase
string
flAtivo
boolean
idUsuarioClienteXFuncionalidade
integer
int64
flDonoPalavraChave
integer
int64
vincularTodosDiarios
boolean
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioAlteracao
integer
int64
dataHoraUlAlteracao
string
date-time
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/usuario-cliente-palavras-chaves/ativar
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/usuario-cliente-palavras-chaves/inativar
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
DELETE
/core/v1/usuario-cliente-palavras-chaves/
{id}Path variables
id
integer
int64
required
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos excluidos.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/usuario-cliente-palavras-chaves/
{id}/diariosPath variables
id
integer
int64
required
Request parameters
IDsUsuarioClienteXPalChave
string
optional
IDsUsuarioClienteXDiario
string
optional
Ativo
boolean
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/usuario-cliente-palavras-chaves/adicionar-diarios
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Array
Object
idDiario
integer
int64
idUsuarioClienteXPalChave
integer
int64
required
vincularTodosDiarios
boolean
idUsuarioInclusao
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/usuario-cliente-palavras-chaves/
{id}/diarios/ativarPath variables
id
integer
int64
required
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/usuario-cliente-palavras-chaves/
{id}/diarios/inativarPath variables
id
integer
int64
required
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/clientes
PUT
/core/v1/clientes
POST
/core/v1/clientes
GET
/core/v1/clientes
Exemplo:
Consulta a Clientes Partner Api
GET /v1/clientes
Retorna todos os Campos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&Campos=*
Buscar Clientes Específicos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&IDs=96771,2C96797&Campos=*
Buscar Campos Específicos
/core/v1/clientes?PaginaAtual=1&RegistrosPorPagina=10&Campos=pessoaCliente.nome%2C%20pessoaCliente.email&Expansao=pessoaCliente
Usando filtro específico (possíveis: nome, email, cpfcnpj, idplano, idcontrato, telefone)
/core/v1/clientes?Email=umnovoteste%40mailna.co&CPFCNPJ=83048590846&PaginaAtual=1&RegistrosPorPagina=10&Campos=*Request parameters
Nome
string
optional
Email
string
optional
CPFCNPJ
string
optional
IdPlano
integer
int64
optional
IdContrato
integer
int64
optional
Telefone
string
optional
Ativo
boolean
optional
OrgaoPublico
boolean
optional
UtilizaPerfil
boolean
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Coluna
string
optional
Ordem
string
optional
Limitado
boolean
optional
IdProdutoAdviseContratado
integer
int64
optional
IdParceiro
integer
int64
optional
PossuiContrato
boolean
optional
PossuiUsuario
boolean
optional
PossuiGrupo
boolean
optional
ConsultaParceiros
boolean
optional
IDs
string
optional
Campos
string
optional
Expansao
string
optional
Q
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
PUT
/core/v1/clientes
Exemplo:
Alteração de Clientes
Alterando Nome
PUT core/v1/clientes
}
"itens": [
{
"Id": 96837,
"pessoaCliente": {
"Id": 117934,
"nome": "Alterado API"
}
}
]
}
Outras Alterações
PUT core/v1/clientes
{
"itens": [
{
"Id": 96837,
"pessoaCliente": {
"Id": 117934,
"nome": "Alterado API",
"email": "alteradoapi@mailna.co",
"cpfcnpj": "48138896116",
"dataNascimentoAbertura": "",
"fone1": "",
"fone2": "",
"celular1": "",
"idSexo": -3,
"idTipoPessoa": -1,
"celular2": "",
"idUFMunicipio": "",
"idMunicipio": "",
"logradouro": "",
"numeroEndereco": "",
"complementoEndereco": "",
"cep": "",
"observacao": ""
}
}
]
}
Inativação e Ativação de Clientes
PUT core/v1/clientes/inativar
{
"iDs": [
96826,96837
]
}
PUT core/v1/clientes/ativar
{
"iDs": [
96826,96837
]
}Request parameters
Campos
string
optional
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
itens
Array
Object
id
integer
int64
required
idPessoa
integer
int64
required
orgaoPublico
boolean
required
ativo
boolean
required
utilizaPerfil
boolean
required
idProdutoAdviseContratado
integer
int64
nomeProdutoAdviseContratado
string
idParceiro
integer
int64
possuiGrupo
boolean
pessoaCliente
Object
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
contratos
Array
Object
id
integer
int64
numero
string
consorcio
boolean
convenioOAB
boolean
parceria
boolean
dataContratacao
string
date-time
dataInicioVigencia
string
date-time
dataFimVigencia
string
date-time
cortesia
boolean
situacaoContrato
integer
int32
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
Object
idContratoXFuncionalidade
integer
int64
idFuncionalidade
integer
int64
nomeFuncionalidade
string
planos
Array
Object
id
integer
int64
idPlano
integer
int64
nome
string
idTipoPlano
integer
int64
nomeTipoPlano
string
ativo
boolean
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
Object
idContratoXFuncionalidade
integer
int64
idFuncionalidade
integer
int64
nomeFuncionalidade
string
usuarios
Array
Object
id
integer
int64
idPessoa
integer
int64
usuarioAdministrador
boolean
pessoa
Object
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
idCliente
integer
int64
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string
date-time
emailUsuario
string
planosVinculados
Array
Object
id
integer
int64
idContrato
integer
int64
idCliente
integer
int64
idContratoXPlano
integer
int64
dataAdesao
string
date-time
idSituacaoClienteXPlano
integer
int64
ativo
boolean
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
nomePlanoBase
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
POST
/core/v1/clientes
Exemplo:
Inclusão de Clientes Partner API
POST core/v1/clientes
{
"itens": [
{
"pessoaCliente": {
"nome": "Teste Feliz",
"email": "testefeliz@mailna.co",
"cpfcnpj": "48138896116",
"dataNascimentoAbertura": "",
"fone1": "",
"fone2": "",
"celular1": "",
"idSexo": -3,
"idTipoPessoa": -1,
"celular2": "",
"idUFMunicipio": "",
"idMunicipio": "",
"logradouro": "",
"numeroEndereco": "",
"complementoEndereco": "",
"cep": "",
"observacao": ""
}
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
itens
Array
Object
id
integer
int64
required
idPessoa
integer
int64
required
orgaoPublico
boolean
required
ativo
boolean
required
utilizaPerfil
boolean
required
idProdutoAdviseContratado
integer
int64
nomeProdutoAdviseContratado
string
idParceiro
integer
int64
possuiGrupo
boolean
pessoaCliente
Object
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
contratos
Array
Object
id
integer
int64
numero
string
consorcio
boolean
convenioOAB
boolean
parceria
boolean
dataContratacao
string
date-time
dataInicioVigencia
string
date-time
dataFimVigencia
string
date-time
cortesia
boolean
situacaoContrato
integer
int32
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
Object
idContratoXFuncionalidade
integer
int64
idFuncionalidade
integer
int64
nomeFuncionalidade
string
planos
Array
Object
id
integer
int64
idPlano
integer
int64
nome
string
idTipoPlano
integer
int64
nomeTipoPlano
string
ativo
boolean
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
Object
idContratoXFuncionalidade
integer
int64
idFuncionalidade
integer
int64
nomeFuncionalidade
string
usuarios
Array
Object
id
integer
int64
idPessoa
integer
int64
usuarioAdministrador
boolean
pessoa
Object
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
idCliente
integer
int64
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string
date-time
emailUsuario
string
planosVinculados
Array
Object
id
integer
int64
idContrato
integer
int64
idCliente
integer
int64
idContratoXPlano
integer
int64
dataAdesao
string
date-time
idSituacaoClienteXPlano
integer
int64
ativo
boolean
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
nomePlanoBase
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
Responses
201
201
Retorna a lista de objetos inseridos.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
GET
/core/v1/usuarios-clientes
PUT
/core/v1/usuarios-clientes
POST
/core/v1/usuarios-clientes
GET
/core/v1/usuarios-clientes
Exemplo:
Consulta Usuários de Clientes
GET core/v1/usuarios-clientes
Retorna todos os Campos
core/v1/usuarios-clientes?PaginaAtual=1&RegistrosPorPagina=10&Campos=*
Retorna Campos Específicos
core/v1/usuarios-clientes?PaginaAtual=1&RegistrosPorPagina=50&Campos=pessoa.nome%2Cpessoa.email%2Cpessoa.fone1%2Cpessoa.cep%2Cpessoa.celular1%2Cpessoa.logradouro%26amp&Expansao=pessoa
Filtros Possíveis: Nome, CPFCNPJ, Telefone, AtivoUsuario, contratosAtivos, usuarioAdministrador
core/v1/usuarios-clientes?PaginaAtual=1&RegistrosPorPagina=50&IdCliente=30986&IDs=107327&Campos=*Request parameters
Nome
string
optional
CPFCNPJ
string
optional
Telefone
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Coluna
string
optional
Ordem
string
optional
IdCliente
integer
int64
optional
AtivoUsuario
boolean
optional
ContratosAtivos
boolean
optional
Limitado
boolean
optional
UsuarioAdministrador
boolean
optional
CodigoIntegracao
string
optional
IDs
string
optional
Campos
string
optional
Expansao
string
optional
Q
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
PUT
/core/v1/usuarios-clientes
Exemplo:
Alteração de dados do usuario cliente
PUT core/v1/usuarios-clientes
{
"itens": [
{
"id": 107670, //idusuariocliente
"pessoa": {
"id": 117928, //idpessoa
"cpfcnpj": "154.534.654-25",
"nome": "Teste 4 alteradop",
"idSexo": -3,
"idTipoPessoa": -1,
"logradouro": "",
"numeroEndereco": "",
"cep": "",
"complementoEndereco": "",
"idParceiro": 15,
"email": "teste4@mailna.co",
"fone1": "",
"fone2": "",
"celular1": "",
"celular2": "",
"observacao": ""
}
}
]
}
Alteração de dados do usuario cliente com funcionalidades
{
"itens": [
{
"id": 107670,
"pessoa": {
"id": 117928,
"cpfcnpj": "154.534.654-25",
"nome": "Teste 4 alteradop",
"idSexo": -3,
"idTipoPessoa": -1,
"logradouro": "",
"numeroEndereco": "",
"cep": "",
"complementoEndereco": "",
"idParceiro": 15,
"email": "teste4@mailna.co",
"fone1": "",
"fone2": "",
"celular1": "",
"celular2": "",
"observacao": ""
},
"contratos": [
{
"id": 12248,
"planos": [
{
"idContratoXPlano": 12309,
"id": 20478,
"servicos": [ ///lembrando que tem que ser passado todos os servicos e funcionalidade senão serão desativados os que não estiverem na lista
{
"id": -6,
"funcionalidades": [
{
"id": -22,
"nome": "Consultar agenda",
"idContratoXFuncionalidade": 1264485,
"selecionado": true,
"quantidadeContratada": 10
}
],
"selecionado": false
}
],
"selecionado": true
}
],
"selecionado": true
}
]
}
]
}
Inativação de Usuário Cliente
PUT core/v1/usuarios-clientes/inativar
{
"iDs": [
107669 ///idusuariocliente
]
}
Ativação de Usuário Cliente
PUT core/v1/usuarios-clientes/ativar
{
"iDs": [
107669 ///idusuariocliente
]
}Request parameters
Campos
string
optional
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
itens
Array
Object
id
integer
int64
idPessoa
integer
int64
required
usuarioAdministrador
boolean
aceitaTermosUso
boolean
usuarioApi
boolean
pessoa
Object
required
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
idCliente
integer
int64
required
emailUsuario
string
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string
date-time
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
codigoIntegracao
string
contratos
Array
Object
id
integer
int64
numero
string
idSituacaoContrato
integer
int64
planos
Array
Object
id
integer
int64
nome
string
nomeTipoPlano
string
idContratoXPlano
integer
int64
servicos
Array
required
Object
id
integer
int64
nome
string
funcionalidades
Array
required
Object
id
integer
int64
nome
string
quantidade
integer
int32
quantidadeUtilizada
integer
int32
quantidadePermitida
integer
int32
quantidadeContratada
integer
int32
idContratoXFuncionalidade
integer
int64
selecionado
boolean
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
required
Object
id
integer
int64
nome
string
quantidade
integer
int32
quantidadeUtilizada
integer
int32
quantidadePermitida
integer
int32
quantidadeContratada
integer
int32
idContratoXFuncionalidade
integer
int64
selecionado
boolean
dadosOAB
Array
Object
id
integer
int64
idUF
integer
int64
required
nomeUF
string
siglaUF
string
idTipoOAB
integer
int64
required
nomeTipoOAB
string
numero
string
ativo
boolean
Responses
200
200
Retorna a lista de objetos alterados.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
POST
/core/v1/usuarios-clientes
Exemplo:
Inclui Novos Usuários de Clientes
POST core/v1/usuarios-clientes
{
"itens": [
{
"IdCliente": 96837,
"pessoa": {
"cpfcnpj": "43282841698",
"nome": "API Amigavel",
"idSexo": -3,
"idTipoPessoa": -1,
"logradouro": "",
"numeroEndereco": "",
"cep": "",
"complementoEndereco": "",
"email": "amigavel@mailna.co",
"fone1": "",
"fone2": "",
"celular1": "",
"celular2": "",
"observacao": ""
}
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
itens
Array
Object
id
integer
int64
idPessoa
integer
int64
required
usuarioAdministrador
boolean
aceitaTermosUso
boolean
usuarioApi
boolean
pessoa
Object
required
id
integer
int64
required
cpfcnpj
string
nome
string
required
idSexo
integer
int64
required
idTipoPessoa
integer
int64
required
logradouro
string
numeroEndereco
string
cep
string
complementoEndereco
string
idMunicipio
integer
int64
idParceiro
integer
int64
dataNascimentoAbertura
string
date-time
email
string
required
fone1
string
fone2
string
celular1
string
celular2
string
observacao
string
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
bairro
string
nomeSexo
string
nomeTipoPessoa
string
nomeMunicipio
string
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
idUFMunicipio
integer
int64
fotoID
string
uuid
foto
string
byte
idCliente
integer
int64
required
emailUsuario
string
ativoUsuario
boolean
nomeCliente
string
nomeUsuario
string
dataHoraUltAcesso
string
date-time
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
nomeUsuarioInclusao
string
nomeUsuarioUltAlteracao
string
codigoIntegracao
string
contratos
Array
Object
id
integer
int64
numero
string
idSituacaoContrato
integer
int64
planos
Array
Object
id
integer
int64
nome
string
nomeTipoPlano
string
idContratoXPlano
integer
int64
servicos
Array
required
Object
id
integer
int64
nome
string
funcionalidades
Array
required
Object
id
integer
int64
nome
string
quantidade
integer
int32
quantidadeUtilizada
integer
int32
quantidadePermitida
integer
int32
quantidadeContratada
integer
int32
idContratoXFuncionalidade
integer
int64
selecionado
boolean
servicos
Array
Object
id
integer
int64
nome
string
funcionalidades
Array
required
Object
id
integer
int64
nome
string
quantidade
integer
int32
quantidadeUtilizada
integer
int32
quantidadePermitida
integer
int32
quantidadeContratada
integer
int32
idContratoXFuncionalidade
integer
int64
selecionado
boolean
dadosOAB
Array
Object
id
integer
int64
idUF
integer
int64
required
nomeUF
string
siglaUF
string
idTipoOAB
integer
int64
required
nomeTipoOAB
string
numero
string
ativo
boolean
Responses
201
201
Retorna a lista de objetos inseridos.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
GET
/core/v1/palavra-chave-cliente/consultar
POST
/core/v1/palavra-chave-cliente/inserir
GET
/core/v1/palavra-chave-cliente/consultar
Exemplo:
Consulta de Palavras Chaves
GET
/core/v1/palavra-chave-cliente/consultar?IdCliente=31053&IdPalavraChave=12373&IdTipoPalavraChave=-1&campos=*
Consulta Tipos de Palavras Chaves
GET
/core/v1/tipos-palavra-chave?campos=*
Consulta Situações de Palavras Chaves
GET
/core/v1/situacoes-palavra-chave?campos=*Request parameters
IdCliente
integer
int64
optional
IdPalavraChave
string
optional
IdPalavraChavePrincipal
integer
int64
optional
IdTipoPalavraChave
integer
int64
optional
IdSituacaoPalavraChave
string
optional
IdUsuarioClienteDono
integer
int64
optional
IdGrupoUsuariosDono
integer
int64
optional
FlPalavraChaveExata
boolean
optional
NomePalavraChave
string
optional
DataHoraInclusao
string
date-time
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Limitado
boolean
optional
ConsultaParceiros
boolean
optional
IdParceiro
integer
int64
optional
IdTipoUsuario
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/palavra-chave-cliente/inserir
Exemplo:
Criação de Palavras Chaves
POST /core/v1/palavra-chave-cliente/inserir
{
"itens": [
{
"idCliente": 97087,
"idSituacaoPalavraChave": -4,
"listaPalavraChave": [
{
"palavraChave": "partner api novo 02",
"idTipoPalavraChave": -1,
"flPalavraChaveExata": false
}
]
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaPalavraChave
Array
Object
palavraChave
string
idTipoPalavraChave
integer
int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
palavraChavePrincipal
string
idClassifPalavraChave
integer
int64
idCliente
integer
int64
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
idSituacaoPalavraChave
integer
int64
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
POST
/core/v1/pesquisa-publicacao/inserir-atualizar
GET
/core/v1/pesquisa-publicacao/consultar
POST
/core/v1/pesquisa-publicacao/inserir-atualizar
Exemplo:
Criar pesquisa de publicação
POST /core/v1/pesquisa-publicacao/inserir-atualizar
{
"itens": [
{
"idUsuarioCliente": 108053,
"listaPesquisaPublicacao": [
{
"flAtualizacao": false,
"idPalavraChave": 83570,
"palavraChave": "partner api novo 02",
"idTipoPalavraChave": -1,
"idDiario": 10178
},
{
"flAtualizacao": false,
"idPalavraChave": 83570,
"palavraChave": "partner api novo 02",
"idTipoPalavraChave": -1,
"idDiario": 10177
},
{
"flAtualizacao": false,
"idPalavraChave": 83570,
"palavraChave": "partner api novo 02",
"idTipoPalavraChave": -1,
"idDiario": 10175
}
]
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
listaPesquisaPublicacao
Array
Object
guid
string
uuid
idPalavraChave
integer
int64
palavraChave
string
idTipoPalavraChave
integer
int64
flPalavraChaveExata
boolean
idPalavraChavePrincipal
integer
int64
palavraChavePrincipal
string
idClassifPalavraChave
integer
int64
idDiario
integer
int64
idUsuarioCliente
integer
int64
flAtualizacao
boolean
idPesqPublicUsuarioCliente
integer
int64
flAtivo
boolean
guid
string
uuid
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
idUsuarioClienteXFuncionalidade
integer
int64
idSituacaoPalavraChave
integer
int64
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
GET
/core/v1/pesquisa-publicacao/consultar
Exemplo:
Consultar Pesquisa de Publicação
GET
/core/v1/pesquisa-publicacao/consultar?FlListarPalChaveContrato=true&FlListarVariacoes=true&IdCliente=31053&IdPalavraChave=12373&IdUsuarioCliente=41772&idTipoPalavraChave=-1&paginaAtual=1®istrosPorPagina=10Request parameters
IdCliente
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdTipoPalavraChave
integer
int64
optional
IdPalavraChave
integer
int64
optional
IdPalavraChavePai
integer
int64
optional
IdContrato
integer
int64
optional
FlListarPalChaveContrato
boolean
optional
FlListarVariacoes
boolean
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Limitado
boolean
optional
IdSituacaoContrato
integer
int64
optional
IdParceiro
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes
GET
/core/v1/publicacoes-clientes/
{id}
PUT
/core/v1/publicacoes-clientes/
{id}/marcar-lido
PUT
/core/v1/publicacoes-clientes/marcar-lidos
PUT
/core/v1/publicacoes-clientes/desmarcar-lidos
GET
/core/v1/publicacoes-clientes
Request parameters
IdsProcessoPublicacao
string
optional
IdsPublClientePalChave
string
optional
DataInicioPublicacao
string
date-time
optional
DataFimPublicacao
string
date-time
optional
IdsDiarios
string
optional
IdsMovProcUsuarioCliente
string
optional
IdsPalavrasChaves
string
optional
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdCliente
integer
int64
optional
Lido
boolean
optional
Ativo
boolean
optional
DataInicioMovimento
string
date-time
optional
DataFimMovimento
string
date-time
optional
IdsCadernosDiarios
string
optional
DataCadastro
string
date-time
optional
Id
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/publicacoes-clientes/
{id}Path variables
id
integer
int64
required
Request parameters
idClienteMovimento
integer
int64
optional
idUsuarioClienteMovimento
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/
{id}/marcar-lidoEsta ação não requer o envio de nenhum dado.
Path variables
id
integer
int64
required
Request parameters
idUsuarioClienteMovimento
integer
int64
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/marcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/publicacoes-clientes/desmarcar-lidos
Esta ação não requer o envio de id do usuario cliente, somente id do movimento.
Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
id
integer
int64
idUsuarioCliente
integer
int64
required
idGrupoUsuarios
integer
int64
idMovProcessoCliente
integer
int64
required
idUsuarioMovimento
integer
int64
pastasRelacionadas
Array
Object
idPastaUsuarioCliente
integer
int64
Examples
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/cabecalhos-processos
GET
/core/v1/processos-clientes/fontes-processos
GET
/core/v1/pastas-usuarios-clientes
GET
/core/v1/movimentos-pastas-usuarios-clientes
POST
/core/v1/processos-clientes
PUT
/core/v1/pastas-usuarios-clientes/inativar
PUT
/core/v1/busca-automatica-processo-usuario-cliente
GET
/core/v1/cabecalhos-processos
Exemplo:
Com o idProcesso do retorno da rota de pastas-usuarios-clientes passar como id em:
GET /core/v1/cabecalhos-processos?idUsuarioCliente=42376&ids=3832335Request parameters
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdFonteProcesso
integer
int64
optional
IdFontePesquisaProcesso
integer
int64
optional
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/processos-clientes/fontes-processos
Exemplo:
Fontes
GET
/core/v1/processos-clientes/fontes-processos?IdProcesso=3832402&IdUsuarioCliente=42376&campos=*®istrosPorPagina=20Request parameters
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
IdUsuarioClienteXFuncionalidade
integer
int64
optional
IdFonteXTipoPesquisa
integer
int64
optional
IdValorParamFontePesq
integer
int64
optional
IdClassificacaoRetorno
integer
int64
optional
IdProcesso
integer
int64
optional
IdsSituacoes
string
optional
NumeroProcesso
string
optional
IdOrgao
integer
int64
optional
SiglaOrgao
string
optional
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/pastas-usuarios-clientes
Exemplo:
Lista os Processos
GET
/core/v1/pastas-usuarios-clientes?ativo=true&campos=*&idTipoPasta=-3&idUsuarioCliente=42376&paginaAtual=1®istrosPorPagina=99Request parameters
IdUsuarioCliente
integer
int64
optional
IdGrupoUsuarios
integer
int64
optional
Ativo
boolean
optional
IdTipoPasta
integer
int64
optional
IDs
string
optional
Nome
string
optional
IdProcesso
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
GET
/core/v1/movimentos-pastas-usuarios-clientes
Exemplo:
Lista de Andamentos do Processo
GET
/core/v1/movimentos-pastas-usuarios-clientes?idFonteProcesso=631309&idPastaUsuarioCliente=101597&idUsuarioCliente=42376&paginaAtual=1®istrosPorPagina=10Request parameters
IdGrupoUsuarios
integer
int64
optional
Ativo
boolean
optional
IdPastaUsuarioCliente
integer
int64
optional
Lido
boolean
optional
IdFonteProcesso
integer
int64
optional
IdTipoMovProcesso
integer
int64
optional
DataMovimentoInicio
string
date-time
optional
DataMovimentoFim
string
date-time
optional
IdFontePesquisa
integer
int64
optional
IdUsuarioCliente
integer
int64
optional
IdCliente
integer
int64
optional
DataPublicacaoInicio
string
date-time
optional
DataPublicacaoFim
string
date-time
optional
IdsDiarios
string
optional
IdsCadernos
string
optional
IdsOrgaosJudiciarios
string
optional
IdsPalavraChave
string
optional
IdsUsuarioClientePalavrasChave
string
optional
NumeroProcesso
string
optional
ValorParametroFonteProcesso
string
optional
IdentificacaoFonteProcesso
string
optional
Pesquisa
string
optional
MovSemRegistroPagina
boolean
optional
CodigosIdsDiarios
array
of
integer
optional
Collection format:
multi
CodigosIdsCadernos
array
of
integer
optional
Collection format:
multi
CodigosIdsOrgaosJudiciarios
array
of
integer
optional
Collection format:
multi
CodigosIdsUsuarioClientePalavrasChave
array
of
integer
optional
Collection format:
multi
CodigosIdsPalavraChave
array
of
integer
optional
Collection format:
multi
IDs
string
optional
CodigosIDs
array
of
integer
optional
Collection format:
multi
PaginaAtual
integer
int32
optional
RegistrosPorPagina
integer
int32
optional
Ordenacao
string
optional
Campos
string
optional
Request headers
Authorization
string
optional
Request body
Responses
200
200
Retorna a lista de objetos consultados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
POST
/core/v1/processos-clientes
Exemplo:
Incluir Processos
POST
/core/v1/processos-clientes
{
"itens": [
{
"processos": [
{
"FlNumUnicaCNJ": true,
"fontesPesquisa": [
{
"idFonteXTipoPesquisa": 220
}
],
"idSitPesqProcUsuarioCliente": -1,
"numeroProcesso": "1007910-42.2019.8.26.0084",
"nomePasta": "1007910-42.2019.8.26.0084"
}
],
"idUsuarioCliente": "41700"
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
objeto
Object
Default:
{
"itens": [
{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}
]
}itens
Array
Object
Default:
{
"ativo": true,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"flDonoProcesso": true,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": "",
"processos": [
{
"id": 1,
"numeroProcesso": "",
"idTipoNumeroProcesso": 1,
"flNumUnicaCNJ": true,
"solicPrimVezCliente": true,
"fontesPesquisa": [
{
"id": 1,
"idProcesso": 1,
"idFonteXTipoPesquisa": 1,
"idValorParamFonteProc": 1,
"flSolicPorPublic": true,
"ativo": true,
"clienteXFontePesqProcDTO": [
{
"idCliente": 1,
"idFontePesqProcesso": 1,
"idLoteProcSpiderUltSuces": 1,
"idLoteProcSpiderUltAgend": 1,
"ativo": true,
"flSolicErroSpider": true,
"pesqProcUsuarioCliente": [
{
"id": 1,
"idClienteXFontePesProc": 1,
"flPesqAndamentoAuto": true,
"flPesqPublicacaoAuto": true,
"idUsuarioClienteXFuncionalidade": 1,
"idSitPesqProcUsuarioCliente": 1,
"idUsuarioInclusao": 1,
"dataHoraInclusao": "",
"idUsuarioUltAlteracao": 1,
"dataHoraUltAlteracao": ""
}
]
}
]
}
]
}
]
}idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
ativo
boolean
flPesqAndamentoAuto
boolean
required
flPesqPublicacaoAuto
boolean
required
idUsuarioClienteXFuncionalidade
integer
int64
required
flDonoProcesso
boolean
idSitPesqProcUsuarioCliente
integer
int64
required
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
processos
Array
Object
id
integer
int64
numeroProcesso
string
required
idTipoNumeroProcesso
integer
int64
flNumUnicaCNJ
boolean
required
solicPrimVezCliente
boolean
nomePasta
string
idSitPesqProcUsuarioCliente
integer
int64
fontesPesquisa
Array
Object
id
integer
int64
required
idProcesso
integer
int64
idFonteXTipoPesquisa
integer
int64
idValorParamFonteProc
integer
int64
flSolicPorPublic
boolean
required
ativo
boolean
clienteXFontePesqProcDTO
Array
Object
idCliente
integer
int64
required
idFontePesqProcesso
integer
int64
required
idLoteProcSpiderUltSuces
integer
int64
idLoteProcSpiderUltAgend
integer
int64
ativo
boolean
flSolicErroSpider
boolean
pesqProcUsuarioCliente
Array
Object
id
integer
int64
required
idClienteXFontePesProc
integer
int64
required
flPesqAndamentoAuto
boolean
required
flPesqPublicacaoAuto
boolean
required
idUsuarioClienteXFuncionalidade
integer
int64
required
idSitPesqProcUsuarioCliente
integer
int64
required
idUsuarioInclusao
integer
int64
dataHoraInclusao
string
date-time
idUsuarioUltAlteracao
integer
int64
dataHoraUltAlteracao
string
date-time
dataHoraUltSolic
string
date-time
Responses
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
401
401
Usuario não logado ou inautorizado.
201
201
Retorna a lista de objetos inseridos.
PUT
/core/v1/pastas-usuarios-clientes/inativar
Exemplo:
Inativa Processos
PUT /core/v1/pastas-usuarios-clientes/inativar
{
"idUsuarioClienteParceiro": 1,
"iDs": [
1 /// Id do Processo em GET /core/v1/pastas-usuarios-clientes
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
idUsuarioClienteParceiro
integer
int64
iDs
Array
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.
PUT
/core/v1/busca-automatica-processo-usuario-cliente
Exemplo:
Inativar Busca de Andamentos por Fonte
PUT
/core/v1/busca-automatica-processo-usuario-cliente
{
"itens": [
{
"idSituacaoPesquisaProcesso": -7,
"idsFontesPesquisaProcesso": [
27898261
],
"idUsuarioCliente": "42376"
}
]
}
Ativar Busca de Andamentos por Fonte
PUT
/core/v1/busca-automatica-processo-usuario-cliente
{
"itens": [
{
"idSituacaoPesquisaProcesso": -1,
"idsFontesPesquisaProcesso": [
27898261
],
"idUsuarioCliente": "42376"
}
]
}Request headers
Authorization
string
optional
Request body
application/json-patch+json
application/json
text/json
application/*+json
Object
itens
Array
Object
idUsuarioCliente
integer
int64
idGrupoUsuarios
integer
int64
idSituacaoPesquisaProcesso
integer
int64
pesquisaAndamentoAutomatica
boolean
pesquisaPublicacaoAutomatica
boolean
idsFontesProcesso
Array
integer
int64
idsFontesPesquisaProcesso
Array
integer
int64
idUsuarioClienteLogado
integer
int64
idClienteLogado
integer
int64
Responses
200
200
Retorna a lista de objetos alterados.
401
401
Usuario não logado ou inautorizado.
400
400
Retorna uma lista de erros padronizados com características da API solicitada.