Comum Resource

GET /advogado-cna

Request Parameters
name type description
oab query
uf query
Response Body
media type data type description
application/json SimpleValueType (JSON)

Example

Request
GET /advogado-cna
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "valor" : "..."
}

GET /advogado-cna-completo

Request Parameters
name type description
oab query
uf query
Response Body
media type data type description
application/json array of AdvogadoWs (JSON)

Example

Request
GET /advogado-cna-completo
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "nome" : "...",
  "oab" : "..."
} ]

GET /consulta-global

Executa a consulta global conforme os parâmetros informados.

Request Parameters
name type description constraints
executar-contagem query boolean
filtro-geral query filtro da consulta.  
ordenacao-chave query  
ordenacao-tipo query  
pagina query int
quan-registros query int
Response Body
media type data type description
application/json ConsultaGlobalsWs (JSON) resultado da consulta.
application/xml ConsultaGlobalsWs (Anonymous) (XML)

Example

Request
GET /consulta-global
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "totalRegistros" : 12345,
  "consultaGlobalWs" : [ {
    "codigoEntidade" : 12345,
    "codigoEntidadePrincipal" : 12345,
    "identificadorEntidade" : "...",
    "textoPrincipal" : "...",
    "textoComplementar" : "...",
    "modulo" : "campo-dinamico",
    "moduloComplementar" : "processo-vara-tipo"
  }, {
    "codigoEntidade" : 12345,
    "codigoEntidadePrincipal" : 12345,
    "identificadorEntidade" : "...",
    "textoPrincipal" : "...",
    "textoComplementar" : "...",
    "modulo" : "processo-relacionado-agrupador-tipo",
    "moduloComplementar" : "compromisso"
  } ]
}

GET /tipo

Request Parameters
name type description
chave-tipo query
Response Body
media type data type description
application/json ConsultaTiposRetornoWs (JSON)
application/xml ConsultaTiposRetornoWs (Anonymous) (XML)

Example

Request
GET /tipo
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "consultaTipoRetorno" : [ {
    "chaveTipo" : "...",
    "quantidadeRegistros" : 12345,
    "simpleDto" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ]
  }, {
    "chaveTipo" : "...",
    "quantidadeRegistros" : 12345,
    "simpleDto" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ]
  } ]
}

GET /cadastro-tipo/modulos

Response Body
media type data type description
application/json SimpleValueWs (JSON) Coleção das chaves do ModuloSistema que possuem entidades com a funcionalidade de cadastro de tipos.
application/xml SimpleValueWs (Anonymous) (XML)

Example

Request
GET /cadastro-tipo/modulos
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}

POST /cadastro-tipo/{moduloCadastroTipo}

Metódo responsável por criar um Tipo.

Request Parameters
name type description
moduloCadastroTipo path
Request Body
media type data type
application/json CadastroTipoWs (JSON)
application/xml CadastroTipoWs (Anonymous) (XML)
Response Body
media type data type description
application/json object (JSON) retorna o codigo do tipo criado.
application/xml anyType (XML)

Example

Request
POST /cadastro-tipo/{moduloCadastroTipo}
Content-Type: application/json
Accept: application/json

                
{
  "codigoCadastroTipo" : 12345,
  "descricao" : "...",
  "flagPossuiModulo" : true,
  "flagPossuiArrendatario" : true,
  "modulos" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /cadastro-tipo/{moduloCadastroTipo}

Metódo responsável por editar um Tipo.

Request Parameters
name type description
moduloCadastroTipo path
Request Body
media type data type
application/json CadastroTipoWs (JSON)
application/xml CadastroTipoWs (Anonymous) (XML)

Example

Request
PUT /cadastro-tipo/{moduloCadastroTipo}
Content-Type: application/json

                
{
  "codigoCadastroTipo" : 12345,
  "descricao" : "...",
  "flagPossuiModulo" : true,
  "flagPossuiArrendatario" : true,
  "modulos" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ]
}
Response
HTTP/1.1 204 No Content

GET /consulta/modulos

Response Body
media type data type description
application/json SimpleValueWs (JSON)
application/xml SimpleValueWs (Anonymous) (XML)

Example

Request
GET /consulta/modulos
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}

GET /consulta/{moduloConsulta}

Request Parameters
name type description constraints
moduloConsulta path  
codigo-registro-vinculo query long
executar-contagem query boolean
filtro-geral query  
ordenacao-chave query  
ordenacao-tipo query  
pagina query int
quan-registros query int
Response Body
media type data type description
application/json object (JSON)
application/xml anyType (XML)

Example

Request
GET /consulta/{moduloConsulta}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

POST /consulta/{moduloConsulta}

Request Parameters
name type description constraints
moduloConsulta path  
codigo-registro-vinculo query long
executar-contagem query boolean
ordenacao-chave query  
ordenacao-tipo query  
pagina query int
quan-registros query int
Response Body
media type data type description
application/json object (JSON)
application/xml anyType (XML)

Example

Request
POST /consulta/{moduloConsulta}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

GET /habilitar-desabilitar/modulos

Response Body
media type data type description
application/json SimpleValueWs (JSON) Coleção das chaves do ModuloSistema que possuem entidades com a funcionalidade de habilitar e desabilitar.
application/xml SimpleValueWs (Anonymous) (XML)

Example

Request
GET /habilitar-desabilitar/modulos
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}

GET /remover/modulos

Response Body
media type data type description
application/json SimpleValueWs (JSON) Coleção das chaves do ModuloSistema que possuem entidades com a funcionalidade remover generica.
application/xml SimpleValueWs (Anonymous) (XML)

Example

Request
GET /remover/modulos
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}

GET /tipo/chave

Response Body
media type data type description
application/json ChaveTiposConsultaWs (JSON)
application/xml ChaveTiposConsultaWs (Anonymous) (XML)

Example

Request
GET /tipo/chave
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tipoConsulta" : [ {
    "chaveTipo" : "...",
    "paginacaoTiposConsulta" : "NAO_OBRIGATORIO",
    "filtroTiposConsulta" : [ {
      "filtro" : "...",
      "valorDefaultFiltro" : "...",
      "filtroObrigatorio" : true
    }, {
      "filtro" : "...",
      "valorDefaultFiltro" : "...",
      "filtroObrigatorio" : true
    } ]
  }, {
    "chaveTipo" : "...",
    "paginacaoTiposConsulta" : "NAO_OBRIGATORIO",
    "filtroTiposConsulta" : [ {
      "filtro" : "...",
      "valorDefaultFiltro" : "...",
      "filtroObrigatorio" : true
    }, {
      "filtro" : "...",
      "valorDefaultFiltro" : "...",
      "filtroObrigatorio" : true
    } ]
  } ]
}

POST /{moduloHabilitarDesabilitar}/desabilitar

Desabilitar um registro de uma entidade do sistema.

Request Parameters
name type description constraints multivalued
moduloHabilitarDesabilitar path chave do ModuloSistema referente a entidade a ser desabilitada.   no
codigos query long yes
Response Body
media type data type description
application/json object (JSON) Response.
application/xml anyType (XML)

Example

Request
POST /{moduloHabilitarDesabilitar}/desabilitar
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

POST /{moduloHabilitarDesabilitar}/habilitar

Habilita um registro de uma entidade do sistema.

Request Parameters
name type description constraints multivalued
moduloHabilitarDesabilitar path chave do ModuloSistema referente a entidade a ser habilitada.   no
codigos query codigo do registro a ser habilitado. long yes
Response Body
media type data type description
application/json object (JSON) Response.
application/xml anyType (XML)

Example

Request
POST /{moduloHabilitarDesabilitar}/habilitar
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /{moduloRemoverEntidade}/remover

Remove um registro de uma entidade do sistema.

Request Parameters
name type description constraints multivalued
moduloRemoverEntidade path chave do ModuloSistema referente a entidade a ser removida.   no
codigos query codigo do registro a ser removido. long yes
Response Body
media type data type description
application/json object (JSON) Response.
application/xml anyType (XML)

Example

Request
DELETE /{moduloRemoverEntidade}/remover
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /cadastro-tipo/consulta/{moduloCadastroTipo}

Request Parameters
name type description constraints
moduloCadastroTipo path  
executar-contagem query boolean
filtro-geral query  
ordenacao-chave query  
ordenacao-tipo query  
pagina query int
quan-registros query int
Response Body
media type data type description
application/json CadastroTipoConsultaWs (JSON)
application/xml CadastroTipoConsultaWs (Anonymous) (XML)

Example

Request
GET /cadastro-tipo/consulta/{moduloCadastroTipo}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "totalRegistros" : 12345,
  "modulosPossiveis" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ],
  "cadastroTipoWs" : [ {
    "codigoCadastroTipo" : 12345,
    "descricao" : "...",
    "flagPossuiModulo" : true,
    "flagPossuiArrendatario" : true,
    "modulos" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ]
  }, {
    "codigoCadastroTipo" : 12345,
    "descricao" : "...",
    "flagPossuiModulo" : true,
    "flagPossuiArrendatario" : true,
    "modulos" : [ {
      "chave" : 12345,
      "valor" : "..."
    }, {
      "chave" : 12345,
      "valor" : "..."
    } ]
  } ]
}

GET /cadastro-tipo/modulos/areas

Response Body
media type data type description
application/json ModuloAgrupadosRetornoWs (JSON)
application/xml ModuloAgrupadosRetornoWs (Anonymous) (XML)

Example

Request
GET /cadastro-tipo/modulos/areas
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "moduloAreaRetorno" : [ {
    "moduloArea" : "financeiro",
    "simpleValue" : [ {
      "valor" : "..."
    }, {
      "valor" : "..."
    } ]
  }, {
    "moduloArea" : "processo",
    "simpleValue" : [ {
      "valor" : "..."
    }, {
      "valor" : "..."
    } ]
  } ]
}

GET /consulta/{moduloConsulta}/ordenacao

Request Parameters
name type description
moduloConsulta path
Response Body
media type data type description
application/json SimpleValueWs (JSON)
application/xml SimpleValueWs (Anonymous) (XML)

Example

Request
GET /consulta/{moduloConsulta}/ordenacao
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}

GET /cadastro-tipo/codigo-cadastro-tipo/{moduloCadastroTipo}/{codigoCadastroTipo}

Metódo responsável por obter um cadastro tipo pelo codigo

Request Parameters
name type description constraints
codigoCadastroTipo path long
moduloCadastroTipo path  
Response Body
media type data type description
application/json CadastroTipoWs (JSON)
application/xml CadastroTipoWs (Anonymous) (XML)

Example

Request
GET /cadastro-tipo/codigo-cadastro-tipo/{moduloCadastroTipo}/{codigoCadastroTipo}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "codigoCadastroTipo" : 12345,
  "descricao" : "...",
  "flagPossuiModulo" : true,
  "flagPossuiArrendatario" : true,
  "modulos" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ]
}

POST /habilitar-desabilitar/consulta/desabilitado/{moduloEntidade}

Metódo responsável por consultar todos os registros de uma entidade que estão desabilitados filtrados ou nao por uma lista de ids.

Request Parameters
name type description
moduloEntidade path
Request Body
media type data type
application/json SimpleValueWs (JSON)
application/xml SimpleValueWs (Anonymous) (XML)
Response Body
media type data type description
application/json SimpleDtoWs (JSON) retorna o SimpleDtoWs
application/xml SimpleDtoWs (Anonymous) (XML)

Example

Request
POST /habilitar-desabilitar/consulta/desabilitado/{moduloEntidade}
Content-Type: application/json
Accept: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "simpleDto" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ]
}

POST /habilitar-desabilitar/consulta/habilitado/{moduloEntidade}

Metódo responsável por consultar todos os registros de uma entidade que estão habilitados filtrados ou nao por uma lista de ids.

Request Parameters
name type description
moduloEntidade path
Request Body
media type data type
application/json SimpleValueWs (JSON)
application/xml SimpleValueWs (Anonymous) (XML)
Response Body
media type data type description
application/json SimpleDtoWs (JSON) retorna o SimpleDtoWs
application/xml SimpleDtoWs (Anonymous) (XML)

Example

Request
POST /habilitar-desabilitar/consulta/habilitado/{moduloEntidade}
Content-Type: application/json
Accept: application/json

                
{
  "simpleValue" : [ {
    "valor" : "..."
  }, {
    "valor" : "..."
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "simpleDto" : [ {
    "chave" : 12345,
    "valor" : "..."
  }, {
    "chave" : 12345,
    "valor" : "..."
  } ]
}