WEB SERVICE – PROJURIS – V. 1.3
WEB SERVICE
PROJURIS
VERSÃO 1.3
1
WEB SERVICE – PROJURIS – V. 1.3
Sumário
1.
IMPORTANTE! ............................................................................................................................................................ 3
2.
PROPRIDADES DA INTERFACE .................................................................................................................................... 3
3.
HEADERS (ADDITIONAL HTTP HEADERS FOR THIS MESSAGE) ................................................................................... 3
4.
MÉTODOS................................................................................................................................................................... 4
4.1. MÉTODO: DELETE ...................................................................................................................................................... 4
4.1.1.
PARÂMETROS ..................................................................................................................................4
4.1.1.1. DADOS DA ENTIDADE (<entidade>) ............................................................................................................ 4
4.2. MÉTODO: DELETEBYID .............................................................................................................................................. 8
4.2.1.
PARÂMETROS ..................................................................................................................................8
4.2.1.1. ID DA ENTIDADE (<id>)................................................................................................................................ 8
4.3. MÉTODO: FINDBYID .................................................................................................................................................. 8
4.3.1.
PARÂMETROS ..................................................................................................................................8
4.3.1.1. ID DA ENTIDADE (<id>)................................................................................................................................ 8
4.4. MÉTODO: FINDBYNOME ........................................................................................................................................... 8
4.4.1.
PARÂMETROS ..................................................................................................................................8
4.4.1.1. NOME DA ENTIDADE (<nome>) .................................................................................................................. 8
4.5. MÉTODO: INSERT ...................................................................................................................................................... 8
4.5.1.
PARÂMETROS ..................................................................................................................................8
4.5.1.1. DADOS DA ENTIDADE (<entidade>) ............................................................................................................ 8
4.6. METODO: SAVE.......................................................................................................................................................... 9
4.6.1.
PARÂMETROS ..................................................................................................................................9
4.6.1.1. DADOS DA ENTIDADE (<entidade>) ............................................................................................................ 9
4.7. MÉTODO: UPDATE..................................................................................................................................................... 9
4.7.1.
PARÂMETROS ..................................................................................................................................9
4.7.1.1. ID DA ENTIDADE (<idEntidade>) ................................................................................................................. 9
4.7.1.2. DADOS DA ENTIDADE (<entidade>) ............................................................................................................ 9
5.
MENSAGENS DE ERRO ............................................................................................................................................. 10
5.1.
MENSAGENS FIXAS ........................................................................................................................ 10
5.2.
MENSAGENS DINÂMICAS ............................................................................................................... 10
2
WEB SERVICE – PROJURIS – V. 1.3
1. IMPORTANTE!
O WEB SERVICE ESTÁ DISPONÍVEL PARA CLIENTES QUE UTILIZAM SERVIDOR DE APLICAÇÃO JBOSS.
2. PROPRIDADES DA INTERFACE
Linguagem
WSDL
Nome
projuris/entidadeWSSoapBinding
URL
http://endereço_acesso_projuris/entidadeWS?WSDL
Binding
{http://service.ws.projurisweb.com.br/}projuris/entidadeWSSoapBinding
Versão SOAP
SOAP 1.1
Cache
true
Estilo
RPC
WS-A versão
NONE
WS-A anônimo Opcional
3. HEADERS (ADDITIONAL HTTP HEADERS FOR THIS MESSAGE)
Para executar os métodos do Web Service via ferramenta soapUI, é necessário adicionar a seguinte
informação no Header:
Header
Valor
Authorization: Basic YWRtaW46cHJvamV0b3M=
Observação: O Valor exemplo informado é a String “admin:projetos” (usuário:senha) na base64.
3
WEB SERVICE – PROJURIS – V. 1.3
4. MÉTODOS
4.1. MÉTODO: DELETE
4.1.1. PARÂMETROS
4.1.1.1.
DADOS DA ENTIDADE (<entidade>)
CAMPO
TIPO
REQUERIDO
<adverso>true</adverso>
Boleano
SIM
É adverso?
<advogado>false</advogado>
Boleano
SIM
É advogado?
<bairro>Bom Retiro</bairro>
String
NÃO
Bairro do endereço.
<categoria>Adverso</categoria>
Inteiro
NÃO
Nome/sigla da
categoria cliente
adverso.
<cep>20560-002</cep>
String
NÃO
CEP do endereço.
<cidade>Joinville</cidade>
String
NÃO
Nome/Sigla do
município, relacionado
ao nome/sigla do
estado.
Boleano
SIM
É cliente?
<codigoEstrutural>1231213</codigoEstrutural>
String
NÃO
<complemento>12º andar</complemento>
String
NÃO
Complemento do
endereço.
<contato>José Roberto</contato>
String
NÃO
Contato.
<dataNascimento>21/08/1981</dataNascimento>
String
NÃO
Data de Nascimento.
Boleano
SIM
É depositário?
<cliente>false</cliente>
<depositario>false</depositario>
OBSERVAÇÃO
4
WEB SERVICE – PROJURIS – V. 1.3
<email>[email protected]</email>
String
NÃO
E-mail de contato.
Boleano
SIM
É emissor?
String
NÃO
Endereço da entidade.
Boleano
SIM
É escritório de
terceiro?
<estado>SC</estado>
String
NÃO
Nome/sigla do estado,
relacionado ao nome
do país.
<estadoCivil>N</estadoCivil>
String
NÃO
Estado civil.
Boleano
SIM
É estrangeiro.
String
NÃO
Fax.
Boleano
SIM
É fornecedor?
<grupoEconomico>123</grupoEconomico>
Inteiro
NÃO
Grupo econômico.
<homePage>www.concremat.com.br</homePage>
String
NÃO
Home page.
<idEntidade>20</idEntidade>
Inteiro
NÃO
Caso seja uma nova
entidade não é
necessário passar.
<pais>Brasil</pais>
Inteiro
NÃO
Nome/sigla do país.
<inscricaoEstadual>81.621.780</inscricaoEstadual>
String
NÃO
Inscrição Estadual.
<inscricaoMunicipal>00.723.64-9</inscricaoMunicipal>
String
NÃO
Inscrição Municipal.
NÃO
Mascara
<emissor>false</emissor>
<endereco>Avenida São João</endereco>
<escritorioTerceiro>false</escritorioTerceiro>
<estrangeiro>false</estrangeiro>
<fax>(21) 2210-6316</fax>
<fornecedor>false</fornecedor>
<mascara>?</mascara>
<matricula>11111</matricula>
String
NÃO
Matrícula.
<nacionalidade>Brasileiro</nacionalidade>
String
NÃO
Valor do campo
estrangeiro.
Se estrangeiro igual a
‘true’, então é
“Estrangeiro”, senão é
“Brasileiro”.
<nome>José João da Silva</nome>
String
NÃO
Nome. Ex.: “Crefisa” ou
“Maria”.
<numero>344</numero>
String
NÃO
Número do endereço.
5
WEB SERVICE – PROJURIS – V. 1.3
<numeroDocumento>796.426.148-71</numeroDocumento>
String
SIM
Número do
documento.
Ex.: “91.241.896/000156”.
Chave principal de
validação, para criação
ou atualização da
entidade, através do
número do
documento.
<observacao>qualquer informação</observacao>
String
NÃO
Observação.
<orgaoEmissor>SSP</orgaoEmissor>
String
NÃO
Orgão emissor. Ex.:
“SSP”.
<outorgado>false</outorgado>
Boleano
SIM
É outorgado?
<outorgante>false</outorgante>
Boleano
SIM
É outorgante?
<pessoaFisica>false</pessoaFisica>
Boleano
SIM
Pessoa Física? Define
se a entidade é física
ou jurídica.
<pessoaJuridica>true</pessoaJuridica>
Boleano
SIM
Pessoa Jurídica? Define
se a entidade é física
ou jurídica.
<principal>true</principal>
Boleano
SIM
É o documento
principal?
<profissao>Advogado</profissao>
String
NÃO
Profissão. Ex.:
“Bancário”.
<qualificacao>Peritos, Perito Médico</qualificacao>
String
NÃO
Qualificação.
Ex.: “Áreas de Atuação:
- Cível;
- Empresarial;
Boleano
SIM
É quotista?
<ramal>3165</ramal>
String
NÃO
Ramal.
<razaoSocial>Limpadora Denver</razaoSocial>
String
NÃO
Razão Social.
<sexo>M</sexo>
String
NÃO
Sexo. Ex.: “M” ou “F”.
<sigla>SNSOO</sigla>
String
NÃO
Sigla
<telCelular>(21) 9496-8669</telCelular>
String
NÃO
Telefone Celular.
<quotista>false</quotista>
6
WEB SERVICE – PROJURIS – V. 1.3
<telComercial>(21) 2277-4200 </telComercial>
String
NÃO
Telefone Comercial.
<telResidencial>(21) 2525-3560</telResidencial>
String
NÃO
Telefone Residencial.
<tipoDocumento>CPF</tipoDocumento>
Inteiro
NÃO
Referente ao
nome/sigla de
cadastro: CPF, CNPJ,
RG etc.
<tipoPessoa>J</tipoPessoa>
String
NÃO
Define se a entidade é
física ou jurídica. Ex.:
“F” ou “J”.
<tratamento>Sr.</tratamento>
String
NÃO
Tratamento. Ex.: “Sra.“,
“Dr.” etc..
RETORNO: CÓDIGO DA ENTIDADE | STRING
7
WEB SERVICE – PROJURIS – V. 1.3
4.2. MÉTODO: DELETEBYID
4.2.1. PARÂMETROS
4.2.1.1.
ID DA ENTIDADE (<id>)
CAMPO
<id>1</id>
TIPO
REQUERIDO
String
SIM
OBSERVAÇÃO
Chave primária da tabela de M_ENTIDADE.
RETORNO: CÓDIGO DA ENTIDADE | STRING
4.3. MÉTODO: FINDBYID
4.3.1. PARÂMETROS
4.3.1.1.
ID DA ENTIDADE (<id>)
CAMPO
<id>1</id>
TIPO
REQUERIDO
String
SIM
OBSERVAÇÃO
Chave primária da tabela de M_ENTIDADE.
RETORNO: ENTIDADE | ESTRUTURA <ENTIDADE>
4.4. MÉTODO: FINDBYNOME
4.4.1. PARÂMETROS
4.4.1.1.
NOME DA ENTIDADE (<nome>)
CAMPO
<nome>1</nome>
TIPO
REQUERIDO
String
SIM
OBSERVAÇÃO
Nome da entidade. Tabela M_ENTIDADE, campo nome.
RETORNO: ENTIDADE | ESTRUTURA <ENTIDADE>
4.5. MÉTODO: INSERT
4.5.1. PARÂMETROS
4.5.1.1.
DADOS DA ENTIDADE (<entidade>)
Utilizar o mesmos parâmetros do método DELETE (Seção 4.1.1.1).
RETORNO: CÓDIGO DA ENTIDADE | STRING
8
WEB SERVICE – PROJURIS – V. 1.3
4.6. METODO: SAVE
4.6.1. PARÂMETROS
4.6.1.1.
DADOS DA ENTIDADE (<entidade>)
Utilizar o mesmos parâmetros do método DELETE (Seção 4.1.1.1).
RETORNO: CÓDIGO DA ENTIDADE | STRING
4.7. MÉTODO: UPDATE
4.7.1. PARÂMETROS
4.7.1.1.
ID DA ENTIDADE (<idEntidade>)
CAMPO
TIPO
<idEntidade>1</idEntidade>
4.7.1.2.
REQUERIDO
String
SIM
OBSERVAÇÃO
Chave primária da tabela de M_ENTIDADE.
DADOS DA ENTIDADE (<entidade>)
Utilizar o mesmos parâmetros do método DELETE (Seção 4.1.1.1).
RETORNO: CÓDIGO DA ENTIDADE | STRING
9
WEB SERVICE – PROJURIS – V. 1.3
5. MENSAGENS DE ERRO
5.1. MENSAGENS FIXAS
DIGITE_LOGIN_SENHA = Usuário e senha inválidos.
RELACIONAMENTOINVALIDO_PAISxESTADO = País ou estado não cadastrado(s) ou relacionado(s).
RELACIONAMENTOINVALIDO_ESTADOxMUNICIPIO = Estado ou município não cadastrado(s) ou relacionado(s).
VALORINVALIDO_MUNICIPIO = Código do município não cadastrado.
VALORINVALIDO_TIPOVALOR_NAOSTRING = Valor não pode ser String.
VALORINVALIDO_CONVERTER_STRINGTOBOOLEAN = Valor convertido não é Boleano.
5.2. MENSAGENS DINÂMICAS
Comportamento quando não existe país, estado, município, tipo de documento ou categoria cadastradas, segue
exemplos:
Para país: "Nenhum registro com o nome/sigla Brazil na tabela país".
Para estado: "Nenhum registro com o nome/sigla SJ na tabela UF/estado".
Para município: "Nenhum registro com o nome/sigla Floripa na tabela município".
Para categoria: "Nenhum registro com o nome/sigla Adversos na tabela categoria".
Para tipo de documento: "Nenhum registro com o nome/sigla CNPJ2 na tabela documento".
10