mapa - ministério da agricultura, pecuária e abastecimento -...
TRANSCRIPT
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos
Manual de Utilização dos Serviços
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.3
Especificação dos Serviços Data: 03/12/2013
MAPA/SE/SPOA/CGTI. Página 2 de 21
Versão do Template: 1.2
Histórico de Revisão
Data Versão Descrição Autor
17/10/2012 1.0 Versão inicial. Gustavo Antunes
04/03/2013 1.1 Inclusão de serviços Gustavo Antunes
20/08/2013 1.2 Descrição dos serviços de inclusão de pessoa física e inclusão de pessoa jurídica
Gustavo Antunes
03/12/2013 1.3 Adequação ao template 1.2 Thiago Pires
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 3 de 21
ÍNDICE
1. INFORMAÇÕES GERAIS .......................................................................................................................... 5
1.1 GESTORES ................................................................................................................................................ 5
1.1.1 Gestor de Negócio ........................................................................................................................... 5
1.1.2 Gestor Técnico ................................................................................................................................. 5
1.2 ENDEREÇO DO WADL ............................................................................................................................. 5 1.3 REQUISITOS E ORIENTAÇÕES PARA ACESSO ............................................................................................. 5
1.3.1 Solicitação de acesso a serviço restrito ........................................................................................... 5 1.4 REQUISIÇÃO AO SERVIÇO ......................................................................................................................... 5 1.5 RESPOSTA DO SERVIÇO ............................................................................................................................. 6
2 INFORMAÇÕES DETALHADAS .............................................................................................................. 7
2.1 CONSULTAR UNIDADES FEDERATIVAS ............................................................................................. 7
2.1.1 Objetivo ........................................................................................................................................... 7
2.1.2 Pré-condições .................................................................................................................................. 7
2.1.3 Endereço do Serviço ........................................................................................................................ 7
2.1.4 Parâmetros de Entrada ................................................................................................................... 7
2.1.5 Resposta ........................................................................................................................................... 7
2.2 CONSULTAR MUNICÍPIOS........................................................................................................................... 8 2.2.1 Objetivo ........................................................................................................................................... 8
2.2.2 Pré-condições .................................................................................................................................. 8
2.2.3 Endereço do Serviço ........................................................................................................................ 8
2.2.4 Parâmetros de Entrada ................................................................................................................... 8
2.2.5 Resposta ........................................................................................................................................... 8
2.3 CONSULTAR UNIDADE MEDIDA ................................................................................................................. 9 2.3.1 Objetivo ........................................................................................................................................... 9
2.3.2 Pré-condições .................................................................................................................................. 9
2.3.3 Endereço do Serviço ........................................................................................................................ 9
2.3.4 Parâmetros de Entrada ................................................................................................................... 9
2.3.5 Resposta ........................................................................................................................................... 9
2.4 CONSULTAR PAÍSES ................................................................................................................................ 10 2.4.1 Objetivo ......................................................................................................................................... 10
2.4.2 Pré-condições ................................................................................................................................ 10
2.4.3 Endereço do Serviço ...................................................................................................................... 10
2.4.4 Parâmetros de Entrada ................................................................................................................. 10
2.4.5 Resposta ......................................................................................................................................... 10
2.5 CONSULTAR PESSOA FÍSICA POR CPF ....................................................................................................... 11 2.5.1 Objetivo ......................................................................................................................................... 11
2.5.2 Pré-condições ................................................................................................................................ 11
2.5.3 Endereço do Serviço ...................................................................................................................... 11
2.5.4 Parâmetros de Entrada ................................................................................................................. 11
2.5.5 Resposta ......................................................................................................................................... 11
2.6 CONSULTAR PESSOA JURÍDICA POR CNPJ ................................................................................................. 12
2.6.1 Objetivo ......................................................................................................................................... 12
2.6.2 Pré-condições ................................................................................................................................ 12
2.6.3 Endereço do Serviço ...................................................................................................................... 12
2.6.4 Parâmetros de Entrada ................................................................................................................. 12
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 4 de 21
2.6.5 Resposta ......................................................................................................................................... 12
2.7 CONSULTAR PESSOA ESTRANGEIRA ........................................................................................................ 13 2.7.1 Objetivo ......................................................................................................................................... 13
2.7.2 Pré-condições ................................................................................................................................ 13
2.7.3 Endereço do Serviço ...................................................................................................................... 13
2.7.4 Parâmetros de Entrada ................................................................................................................. 13
2.7.5 Resposta ......................................................................................................................................... 14
2.8 INCLUIR PESSOA ESTRANGEIRA ........................................................................................................... 15 2.8.1 Objetivo ......................................................................................................................................... 15
2.8.2 Pré-condições ................................................................................................................................ 15
2.8.3 Endereço do Serviço ...................................................................................................................... 15
2.8.4 Parâmetros de Entrada ................................................................................................................. 15
2.8.5 Arquivo de Exemplo ....................................................................................................................... 15
2.8.6 Resposta ......................................................................................................................................... 16
2.9 INCLUIR PESSOA FÍSICA ..................................................................................................................... 16 2.9.1 Objetivo ......................................................................................................................................... 16
2.9.2 Pré-condições ................................................................................................................................ 16
2.9.3 Endereço do Serviço ...................................................................................................................... 16
2.9.4 Parâmetros de Entrada ................................................................................................................. 16
2.9.5 Arquivo de Exemplo ....................................................................................................................... 17
2.9.6 Resposta ......................................................................................................................................... 18
2.10 INCLUIR PESSOA JURÍDICA ............................................................................................................... 18 2.10.1 Objetivo ......................................................................................................................................... 18
2.10.2 Pré-condições ................................................................................................................................ 18
2.10.3 Endereço do Serviço ...................................................................................................................... 18
2.10.4 Parâmetros de Entrada ................................................................................................................. 18
2.10.5 Arquivo de Exemplo ....................................................................................................................... 19
2.10.6 Resposta ......................................................................................................................................... 19
3 LEGENDA ................................................................................................................................................... 20
4 QUADRO RESUMO ................................................................................................................................... 21
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 5 de 21
1. INFORMAÇÕES GERAIS
Este documento tem como objetivo descrever os detalhes para utilização dos serviços
fornecidos pelo sistema CORPORATIVO desenvolvidos no estilo de arquitetura de software REST.
1.1 GESTORES
1.1.1 Gestor de Negócio
Nome: Thiago Almeida Siqueira
e-mail: [email protected]
Telefone: (61) 3218-2546
Área/Setor: Coordenação Geral de Tecnologia da Informação – CGTI
1.1.2 Gestor Técnico
Nome: Thiago Almeida Siqueira
e-mail: [email protected]
Telefone: (61) 3218-2546
Área/Setor: Coordenação Geral de Tecnologia da Informação – CGTI
1.2 ENDEREÇO DO WADL
• Homologação: http://homolog.agricultura.gov.br/corporativo/servicos/application.wadl
• Produção: http://sistemasweb.agricultura.gov.br/corporativo/servicos/application.wadl
1.3 REQUISITOS E ORIENTAÇÕES PARA ACESSO
O acesso aos serviços descritos neste documento é feito exclusivamente por programas
autorizados sobre o protocolo de comunicação HTTP. O requisito para acesso aos serviços restritos é
possuir usuário cadastrado no MAPA – Ministério da Agricultura, Pecuária e Abastecimento – com
perfil associado ao(s) serviço(s) de interesse. Nas chamadas aos serviços, o cliente deve informar o
usuário e senha (formato md5) fornecidos pelo MAPA. Estes dados devem ser informados a cada
requisição HTTP no cabeçalho, utilizando-se o atributo “Authorization” (Exemplo: Authorization: Basic
MDAwMDAwMDAwMDAxOTE6MTExMTExMTE=). Caso o serviço não seja restrito, não há
necessidade de informar esses dados (usuário e senha).
1.3.1 Solicitação de acesso a serviço restrito
O acesso a um serviço restrito faz-se mediante a utilização de um usuário e senha e
devem ser solicitados ao MAPA. Para tanto, deve-se entrar em contato com o gestor de
negócio do sistema.
1.4 REQUISIÇÃO AO SERVIÇO
Os parâmetros de entrada do serviço podem ser informados dentre 3 (três) tipos:
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 6 de 21
• Path; ou
• Parâmetros; ou
• Arquivo (XML ou JSON)
Para envio de arquivo, deverá ser informado no cabeçalho da requisição o tipo de arquivo
através do atributo “Content-Type” (Exemplo: Content-Type: application/XML). Exemplos dos arquivos
estão descritos no detalhamento do serviço.
1.5 RESPOSTA DO SERVIÇO
O formato da resposta do serviço pode ser escolhida dentre os dois tipos abaixo, sendo que
a opção desejada deve ser enviada no cabeçalho da requisição pelo atributo “Accept” (Exemplo:
Accept: application/json).
• XML: eXtensible Markup Language
• JSON: JavaScript Object Notation
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 7 de 21
2 INFORMAÇÕES DETALHADAS
Abaixo são listados os detalhes dos serviços disponibilizados pelo sistema CORPORATIVO:
2.1 CONSULTAR UNIDADES FEDERATIVAS
2.1.1 Objetivo
Tem como finalidade realizar a consulta das unidades federativas do Brasil. O
sistema deve validar as informações e retornar os registros que atentem a consulta.
2.1.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.1.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/uf
2.1.4 Parâmetros de Entrada
Não se aplica.
2.1.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Lista de registros
chave Sigla da UF 2 AL N/A
valor Nome da UF 50 AL N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 8 de 21
2.2 CONSULTAR MUNICÍPIOS
2.2.1 Objetivo
Tem como finalidade realizar a consulta dos municípios de determinada Unidade
Fedetativa do Brasil. O sistema deve validar as informações e retornar os registros que
atentem a consulta.
2.2.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.2.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/municipio/{sgUF}
2.2.4 Parâmetros de Entrada
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
sgUF Sigla da Unidade Federativa
Sim N/A 2 AL Vide 2.1
2.2.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/hora de execução - DT N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Lista de registros
chave Código do município 10 NU N/A
valor Descrição município 50 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 9 de 21
2.3 CONSULTAR UNIDADE MEDIDA
2.3.1 Objetivo
Tem como finalidade realizar a consulta das unidades de medida utilizadas pelos
sistemas MAPA. O sistema deve validar as informações e retornar os registros que atentem a
consulta.
2.3.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.3.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/unidademedida
2.3.4 Parâmetros de Entrada
Não se aplica.
2.3.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Lista de registros
identificador Identificador da unidade de medida
5 NU N/A
sigla Sigla da unidade de medida 5 AN N/A
descricao Descrição da unidade de medida
30 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 10 de 21
2.4 CONSULTAR PAÍSES
2.4.1 Objetivo
Tem como finalidade realizar a consulta dos países utilizados nos projetos MAPA. O
sistema deve validar as informações e retornar os registros que atentem a consulta.
2.4.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.4.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pais
2.4.4 Parâmetros de Entrada
Não se aplica.
2.4.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora da execução - DT N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Lista de registros
chave Sigla do país 3 AL N/A
valor Nome do país 50 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 11 de 21
2.5 CONSULTAR PESSOA FÍSICA POR CPF
2.5.1 Objetivo
Tem como finalidade realizar a consulta de informações de pessoa física a partir do
CPF. O sistema deve validar as informações e retornar os registros que atentem a consulta.
2.5.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.5.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pessoaFisica/{cpf}
2.5.4 Parâmetros de Entrada
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
CPF CPF da pessoa a ser consultada
Sim N/A 11 AL N/A
2.5.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
identificador Identificador da pessoa 10 NU N/A
nome Nome da pessoa 100 AN N/A
cpf CPF da pessoa 11 AN N/A
rg RG da pessoa 15 AN N/A
dataExpedicaoRg Data de expedição do RG N/A DT N/A
orgaoExpedidorRg Órgão expedidor do RG 2 AL N/A
sexo Sexo 1 AL
M – Masculino
F – Feminino
N – Não informado
dataNascimento Data de nascimento N/A DT N/A
nomePai Nome do pai 100 AN N/A
nomeMae Nome da mãe 100 AN N/A
dataObito Data de óbito N/A DT N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 12 de 21
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
2.6 CONSULTAR PESSOA JURÍDICA POR CNPJ
2.6.1 Objetivo
Tem como finalidade realizar a consulta de informações de pessoa jurídica a partir do CNPJ. O sistema deve validar as informações e retornar os registros que atentem a consulta.
2.6.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.6.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pessoajuridica/{cnpj}
2.6.4 Parâmetros de Entrada
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
CNPJ CNPJ da pessoa a ser consultada
Sim N/A 14 AL N/A
2.6.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
identificador Identificador da pessoa jurídica
10 NU N/A
nmRazaoSocial Razão Social da pessoa jurídica
100 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 13 de 21
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
nmFantasia Nome fantasia da pessoa jurídica
100 AN N/A
nrCnpj CNPJ da pessoa jurídica 14 AN N/A
nrInscricaoEstadual
Número da inscrição estadual
20 AN N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
2.7 CONSULTAR PESSOA ESTRANGEIRA
2.7.1 Objetivo
Tem como finalidade realizar a consulta de informações de pessoa estrangeira a
partir do País de origem. O sistema deve validar as informações e retornar os registros que
atentem a consulta.
2.7.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.7.3 Endereço do Serviço
URI:
http://homolog.agricultura.gov.br/corporativo/servicos/pessoaestrangeira/{sgPais}?nrDocum
ento=&nome=
2.7.4 Parâmetros de Entrada
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
sgPais Sigla do país de origem da pessoa
Sim N/A 3 AL Vide 2.4
nrDocumento Número do documento da pessoa física
Não N/A N/A AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 14 de 21
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
nome Nome da pessoa estrangeira
Sim N/A Ao menos 3 caracteres
AN N/A
2.7.5 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
status Status da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Lista de Registros
identificador Identificador da pessoa estrangeira
10 NU N/A
nome Nome da pessoa estrangeira
300 AN N/A
nrDocumento Número do documento 10 AN N/A
tipoDocumento Tipo de documento 100 AN N/A
email Email da pessoa estrangeira
100 AN N/A
telefone Telefone da pessoa estrangeira
20 AN N/A
endereco Endereço da pessoa estrangeira
200 AN N/A
sgPais País de origem da pessoa estrangeira
3 AL N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 15 de 21
2.8 INCLUIR PESSOA ESTRANGEIRA
2.8.1 Objetivo
Tem como finalidade incluir informações de pessoa. O sistema deve validar as
informações e retornar o identificador do registro incluído.
2.8.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.8.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pessoaestrangeira
2.8.4 Parâmetros de Entrada
Nome do Parâmetro
Descrição do Conteúdo
Obrigatório Máscara Tamanho Tipo de
Preenchimento Domínio
nome Nome da pessoa estrangeira
Sim N/A 300 AN N/A
nrDocumento Número do documento
Não N/A 10 AN N/A
tipoDocumento Tipo do documento
Não N/A 100 AN N/A
email Email da pessoa estrangeira
Não N/A 100 AN N/A
telefone Telefone da pessoa estrangeira
Não N/A 20 AN N/A
endereco Endereço da pessoa estrangeira
Não N/A 200 AN N/A
sgPais País de origem da pessoa estrangeira
Sim N/A 3 AN Vide 2.4
2.8.5 Arquivo de Exemplo
<pessoaEstrangeira>
<nome></nome>
<nrDocumento></nrDocumento>
<tipoDocumento></tipoDocumento>
<email></email>
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 16 de 21
<telefone></telefone>
<endereco></endereco>
<sgPais></sgPais>
</pessoaEstrangeira>
2.8.6 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
identificador Identificador gerado para o registro
10 NU N/A
status Situação da operação 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
2.9 INCLUIR PESSOA FÍSICA
2.9.1 Objetivo
Tem como finalidade incluir informações de pessoa física. O sistema deve validar as
informações e retornar o identificador do registro incluído.
2.9.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.9.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pessoafisica
2.9.4 Parâmetros de Entrada
Nome do Parâmetro Descrição do
Conteúdo Obrigatório Máscara Tamanho
Tipo de Preenchimento
Domínio
nome Nome da pessoa física
Sim N/A 100 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 17 de 21
Nome do Parâmetro Descrição do
Conteúdo Obrigatório Máscara Tamanho
Tipo de Preenchimento
Domínio
cpf Número do CPF
Sim N/A 11 AN N/A
rg Número do RG
Não N/A 15 AN N/A
dataExpedicaoRg Data de expedição do RG
Não N/A - DT N/A
orgaoExpedidorRg Órgão expedidor do RG
Não N/A 20 AN N/A
sexo Sexo Não N/A 1 AL
M – Masculino
F - Feminino
dataNascimento Data de nascimento
Não N/A - DT N/A
nomePai Nome do pai Não N/A 100 AN N/A
nomeMae Nome da mãe Não N/A 100 AN N/A
dataObito Data de óbito Não N/A - DT N/A
2.9.5 Arquivo de Exemplo
<pessoaFisica>
<nome></nome>
<cpf></cpf>
<rg></rg>
<dataExpedicaoRg></dataExpedicaoRg>
<orgaoExpedidorRg></orgaoExpedidorRg>
<sexo></sexo>
<dataNascimento></dataNascimento>
<nomePai></nomePai>
<nomeMae></nomeMae>
<dataObito></dataObito>
</pessoaFisica>
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 18 de 21
2.9.6 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
identificador Identificador gerado para o registro
10 NU N/A
status Código do tipo de solo 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
2.10 INCLUIR PESSOA JURÍDICA
2.10.1 Objetivo
Tem como finalidade incluir informações de pessoa jurídica. O sistema deve validar
as informações e retornar o identificador do registro incluído.
2.10.2 Pré-condições
� Usuário deve ter sido previamente cadastrado; � Usuário deve autenticar-se com sucesso.
2.10.3 Endereço do Serviço
URI: http://homolog.agricultura.gov.br/corporativo/servicos/pessoajuridica
2.10.4 Parâmetros de Entrada
Nome do Parâmetro Descrição do
Conteúdo Obrigatório Máscara Tamanho
Tipo de Preenchimento
Domínio
nmRazaoSocial Nome da pessoa jurídica
Sim N/A 100 AN N/A
nmFantasia Nome Fantasia
Sim N/A 100 AN N/A
nrCnpj Número do CNPJ
Sim N/A 14 AN N/A
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 19 de 21
Nome do Parâmetro Descrição do
Conteúdo Obrigatório Máscara Tamanho
Tipo de Preenchimento
Domínio
nrInscricaoEstadual Número da Inscrição estaudla
Não N/A 20 AN N/A
2.10.5 Arquivo de Exemplo
<pessoaJuridica>
<nmRazaoSocial></nmRazaoSocial>
<nmFantasia></nmFantasia>
<nrCnpj></nrCnpj>
<nrInscricaoEstadual></nrInscricaoEstadual>
</pessoaJuridica>
2.10.6 Resposta
Nome do Parâmetro
Descrição do Conteúdo Tamanho Tipo de
Preenchimento Domínio
Id Identificador da operação 10 NU N/A
dataHoraExecucao
Data/Hora de execução - DT N/A
identificador Identificador gerado para o registro
10 NU N/A
status Código do tipo de solo 1 NU S – Sucesso
E – Erro
Lista de mensagens
codigo Código da mensagem 10 NU N/A
descricao Texto da mensagem 4000 NU N/A
tipo Tipo da mensagem 1 NU
A – Alerta
E – Erro
S – Sucesso
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.03
MAPA/SE/SPOA/CGTI. Página 20 de 21
3 LEGENDA
� AL = Alfa
� AN = Alfanumérico
� AS = Alfanumérico sem caracteres especiais
� NU = Numérico
� DT = Data e/ou Hora
� CH = Char
� BI = bit
� BL = boleano
� N/A = Não se Aplica.
Coordenação Geral de Tecnologia da Informação - CGT I
Corporativo-Sistema de serviços corporativos Versão 1.0
MAPA/SE/SPOA/CGTI. Página 21 de 21
4 QUADRO RESUMO
Nome do Serviço Contexto Tipo de Envio URI Método Acesso Restrito?
Consultar unidade federativa
corporativo Path /servicos/uf GET Sim
Consultar municípios corporativo Path /servicos/município/{sgUF} GET Sim
Consultar unidade medida
corporativo Path /servicos/unidademedida GET Sim
Consultar países corporativo Path /servicos/pais GET Sim
Consultar pessoa física por CPF
corporativo Path /servicos/pessoaFisica/{cpf} GET Sim
Consultar pessoa jurídica por CNPJ
corporativo Path /servicos/pessoajuridica/{cnpj} GET Sim
Consultar pessoa estrangeira
corporativo Path /servicos/pessoaestrangeira/{sgPais}?nrDocumento=&nome=
GET Sim
Incluir pessoa estrangeira corporativo Arquivo /servicos/pessoaestrangeira POST Sim
Incluir pessoa física corporativo Arquivo /servicos/pessoafisica POST Sim
Incluir pessoa jurídica corporativo Arquivo /servicos/pessoajuridica POST Sim