WEB SERVICE PROJURIS V. 1.3 WEB SERVICE PROJURIS VERSÃO 1.3

Transcrição

1 WEB SERVICE PROJURIS VERSÃO 1.3 1

2 Sumário 1. IMPORTANTE! PROPRIDADES DA INTERFACE HEADERS (ADDITIONAL HTTP HEADERS FOR THIS MESSAGE) MÉTODOS MÉTODO: DELETE PARÂMETROS DADOS DA ENTIDADE (<entidade>) MÉTODO: DELETEBYID PARÂMETROS ID DA ENTIDADE (<id>) MÉTODO: FINDBYID PARÂMETROS ID DA ENTIDADE (<id>) MÉTODO: FINDBYNOME PARÂMETROS NOME DA ENTIDADE (<nome>) MÉTODO: INSERT PARÂMETROS DADOS DA ENTIDADE (<entidade>) METODO: SAVE PARÂMETROS DADOS DA ENTIDADE (<entidade>) MÉTODO: UPDATE PARÂMETROS ID DA ENTIDADE (<identidade>) DADOS DA ENTIDADE (<entidade>) MENSAGENS DE ERRO MENSAGENS FIXAS MENSAGENS DINÂMICAS

3 1. IMPORTANTE! O WEB SERVICE ESTÁ DISPONÍVEL PARA CLIENTES QUE UTILIZAM SERVIDOR DE APLICAÇÃO JBOSS. 2. PROPRIDADES DA INTERFACE Linguagem Nome URL Binding WSDL projuris/entidadewssoapbinding { Versão SOAP SOAP 1.1 Cache Estilo WS-A versão true RPC 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

4 4. MÉTODOS 4.1. MÉTODO: DELETE PARÂMETROS DADOS DA ENTIDADE (<entidade>) CAMPO TIPO REQUERIDO OBSERVAÇÃO <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> </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. <cliente>false</cliente> Boleano SIM É cliente? <codigoestrutural> </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. <depositario>false</depositario> Boleano SIM É depositário? 4

5 String NÃO de contato. <emissor>false</emissor> Boleano SIM É emissor? <endereco>avenida São João</endereco> String NÃO Endereço da entidade. <escritorioterceiro>false</escritorioterceiro> 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. <estrangeiro>false</estrangeiro> Boleano SIM É estrangeiro. <fax>(21) </fax> String NÃO Fax. <fornecedor>false</fornecedor> Boleano SIM É fornecedor? <grupoeconomico>123</grupoeconomico> Inteiro NÃO Grupo econômico. <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> </inscricaoestadual> String NÃO Inscrição Estadual. <inscricaomunicipal> </inscricaomunicipal> String NÃO Inscrição Municipal. <mascara>?</mascara> NÃO 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

6 <numerodocumento> </numerodocumento> String SIM Número do documento. Ex.: / 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; <quotista>false</quotista> 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) </telCelular> String NÃO Telefone Celular. 6

7 <telcomercial>(21) </telcomercial> String NÃO Telefone Comercial. <telresidencial>(21) </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

8 4.2. MÉTODO: DELETEBYID PARÂMETROS ID DA ENTIDADE (<id>) CAMPO TIPO REQUERIDO OBSERVAÇÃO <id>1</id> String SIM Chave primária da tabela de M_ENTIDADE. RETORNO: CÓDIGO DA ENTIDADE STRING 4.3. MÉTODO: FINDBYID PARÂMETROS ID DA ENTIDADE (<id>) CAMPO TIPO REQUERIDO OBSERVAÇÃO <id>1</id> String SIM Chave primária da tabela de M_ENTIDADE. RETORNO: ENTIDADE ESTRUTURA <ENTIDADE> 4.4. MÉTODO: FINDBYNOME PARÂMETROS NOME DA ENTIDADE (<nome>) CAMPO TIPO REQUERIDO OBSERVAÇÃO <nome>1</nome> String SIM Nome da entidade. Tabela M_ENTIDADE, campo nome. RETORNO: ENTIDADE ESTRUTURA <ENTIDADE> 4.5. MÉTODO: INSERT PARÂMETROS DADOS DA ENTIDADE (<entidade>) Utilizar o mesmos parâmetros do método DELETE (Seção ). RETORNO: CÓDIGO DA ENTIDADE STRING 8

9 4.6. METODO: SAVE PARÂMETROS DADOS DA ENTIDADE (<entidade>) Utilizar o mesmos parâmetros do método DELETE (Seção ). RETORNO: CÓDIGO DA ENTIDADE STRING 4.7. MÉTODO: UPDATE PARÂMETROS ID DA ENTIDADE (<identidade>) CAMPO TIPO REQUERIDO OBSERVAÇÃO <identidade>1</identidade> String SIM Chave primária da tabela de M_ENTIDADE DADOS DA ENTIDADE (<entidade>) Utilizar o mesmos parâmetros do método DELETE (Seção ). RETORNO: CÓDIGO DA ENTIDADE STRING 9

10 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 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