Diferenças
Aqui você vê as diferenças entre duas revisões dessa página.
Ambos lados da revisão anterior Revisão anterior Próxima revisão | Revisão anterior | ||
pres:gerti:manuais:manual_de_integracao_informa [05/07/2016 16:08] – bholiveira | pres:gerti:manuais:manual_de_integracao_informa [26/12/2017 19:36] (atual) – [INFORMA: Manual de Integração] maugusto | ||
---|---|---|---|
Linha 1: | Linha 1: | ||
- | ====== | + | ====== |
===== Introdução ===== | ===== Introdução ===== | ||
Linha 15: | Linha 15: | ||
==== Objetivo do Projeto ==== | ==== Objetivo do Projeto ==== | ||
- | O objetivo deste projeto é automatizar o processo de envio de informações das licitações e contratações que os Jurisdicionados devem prestar ao TCE-GO. Para automatizar a recepção dos dados, foram implementados vários web services que permitirão à SEGPLAN (Secretaria de Gentão | + | O objetivo deste projeto é automatizar o processo de envio de informações das licitações e contratações que os Jurisdicionados devem prestar ao TCE-GO. Para automatizar a recepção dos dados, foram implementados vários web services que permitirão à SEGPLAN (Secretaria de Gestão |
O escopo inicial é atender a demanda de integrar-se ao sistema COMPRAS-Net, | O escopo inicial é atender a demanda de integrar-se ao sistema COMPRAS-Net, | ||
Linha 53: | Linha 53: | ||
=== Serviço de Formulário (ServiceFormulario.svc)=== | === Serviço de Formulário (ServiceFormulario.svc)=== | ||
- | O serviço de formulários está disponível no endereço web https:// | + | O serviço de formulários está disponível no endereço web https:// |
Qualquer falha de validação ou falha inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException e na sua mensagem será informada qual o problema ocorrido e se possível a forma de resolve-lo. | Qualquer falha de validação ou falha inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException e na sua mensagem será informada qual o problema ocorrido e se possível a forma de resolve-lo. | ||
Linha 59: | Linha 59: | ||
Ao invocar esté método o sistema devolverá um dicionário com todos os órgãos habilitados a receber informações via web service conforme tabela abaixo. | Ao invocar esté método o sistema devolverá um dicionário com todos os órgãos habilitados a receber informações via web service conforme tabela abaixo. | ||
- | Retorno da Consulta | + | **Retorno da Consulta** |
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | Chave long Código do órgão | + | |Chave| long| Código do órgão| |
- | Valor string Texto com o nome do órgão. | + | |Valor| string| Texto com o nome do órgão.| |
== Consulta formulário (ConsultaFormularios)== | == Consulta formulário (ConsultaFormularios)== | ||
Através desse método o usuário poderá consultar todos os formulários ativos para determinado órgão e categoria. Os valores a serem informados deve seguir a tabela abaixo. | Através desse método o usuário poderá consultar todos os formulários ativos para determinado órgão e categoria. Os valores a serem informados deve seguir a tabela abaixo. | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idOrgao long Código do órgão, obtido no método de consulta de orgãos | + | |idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| |
- | + | |idCategoria |long |Código da categoria dos formulários, | |
- | idCategoria long Código da categoria dos formulários, | + | |
O retorno esperado é uma lista de DtoFormulário descrito na seção seguinte. | O retorno esperado é uma lista de DtoFormulário descrito na seção seguinte. | ||
Linha 77: | Linha 76: | ||
Através desse método o usuário poderá consultar todas as opções ativas para determinado campo. O valor a ser informado deve seguir a tabela abaixo. | Através desse método o usuário poderá consultar todas as opções ativas para determinado campo. O valor a ser informado deve seguir a tabela abaixo. | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idCampo long Código do campo, obtido através da Consulta de Formulário, | + | |idCampo |long |Código do campo, obtido através da Consulta de Formulário, |
- | + | |idCategoria |long |Código da categoria dos formulários, | |
- | idCategoria long Código da categoria dos formulários, | + | |
Linha 302: | Linha 300: | ||
< | < | ||
< | < | ||
- | </ | + | |
</ | </ | ||
</ | </ | ||
</ | </ | ||
- | </ | + | </ |
=== Serviço de Informação (ServiceInformacao.svc) === | === Serviço de Informação (ServiceInformacao.svc) === | ||
- | O serviço de informações está disponível no endereço web https:// | + | O serviço de informações está disponível no endereço web https:// |
Qualquer falha de validação ou inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException, | Qualquer falha de validação ou inesperada, para todos os métodos descritos abaixo, será acionada uma exceção do tipo FaultException, | ||
Linha 317: | Linha 315: | ||
Através deste método é possivel enviar a informação desejada e receber de volta o id da informação cadastrada. Os valores a serem informados deve seguir a tabela abaixo. | Através deste método é possivel enviar a informação desejada e receber de volta o id da informação cadastrada. Os valores a serem informados deve seguir a tabela abaixo. | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idOrgao long Código do órgão, obtido no método de consulta de orgãos | + | |idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| |
- | + | |dtoInformação |DtoInformacao|Objeto detalhado na seção seguinte.| | |
- | dtoInformação DtoInformacao | + | |
- | Objeto detalhado na seção seguinte. | + | |
== Envia Arquivo (EnviaArquivo)== | == Envia Arquivo (EnviaArquivo)== | ||
Através deste método é possível enviar os arquivos relacionados a informação, | Através deste método é possível enviar os arquivos relacionados a informação, | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idOrgao long Código do órgão, obtido no método de consulta de orgãos | + | |idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| |
- | + | |idInformacao |long |Código da informação em situação “Em Elaboração”| | |
- | idInformacao long Código da informação em situação “Em Elaboração” | + | |dtoArquivos |DtoArquivos |Objeto detalhado na seção seguinte.| |
- | dtoArquivos DtoArquivos Objeto detalhado na seção seguinte. | + | |
== Remove Arquivo (RemoveArquivo)== | == Remove Arquivo (RemoveArquivo)== | ||
Através deste método é possível remover os arquivos relacionados à informação enviada anteriormente. Os valores a serem informados deve seguir a tabela abaixo, caso a remoção seja realizada com sucesso o método retornará “verdadeiro” confirmando a remoção. Importante ressaltar que esta informação deve estar com o status “Em elaboração”. | Através deste método é possível remover os arquivos relacionados à informação enviada anteriormente. Os valores a serem informados deve seguir a tabela abaixo, caso a remoção seja realizada com sucesso o método retornará “verdadeiro” confirmando a remoção. Importante ressaltar que esta informação deve estar com o status “Em elaboração”. | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idOrgao long Código do órgão, obtido no método de consulta de orgãos | + | |idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| |
- | + | |idInformacao |long |Código da informação em situação “Em Elaboração”| | |
- | idInformacao long Código da informação em situação “Em Elaboração” | + | |dtoArquivos |DtoArquivos |Objeto detalhado na seção seguinte.| |
- | dtoArquivos DtoArquivos Objeto detalhado na seção seguinte. | + | |
== Envia TCE (EnviaTce)== | == Envia TCE (EnviaTce)== | ||
Através deste método é possível marcar a informação como completa, “enviando” a mesma para o Tribunal de Contas do Estado e bloqueando a edição. Durante este processo todos os campos são verificados, | Através deste método é possível marcar a informação como completa, “enviando” a mesma para o Tribunal de Contas do Estado e bloqueando a edição. Durante este processo todos os campos são verificados, | ||
- | Campo Tipo Descrição | + | ^Campo^ Tipo^ Descrição^ |
- | idOrgao long Código do órgão, obtido no método de consulta de orgãos | + | |idOrgao |long |Código do órgão, obtido no método de consulta de orgãos| |
- | + | |idInformacao |long |Código da informação em situação “EmElaboração”| | |
- | idInformacao long Código da informação em situação “EmElaboração” | + | |
== WSDL== | == WSDL== | ||
Linha 599: | Linha 592: | ||
< | < | ||
< | < | ||
- | </ | + | |
</ | </ | ||
</ | </ | ||
</ | </ | ||
- | </ | + | </ |
Linha 609: | Linha 602: | ||
=== Objetos de transferência de dados === | === Objetos de transferência de dados === | ||
Os objetos de transporte utilizados nas requisições e retorno dos métodos dos serviços, descritos na seção anterior estão descritos abaixo: | Os objetos de transporte utilizados nas requisições e retorno dos métodos dos serviços, descritos na seção anterior estão descritos abaixo: | ||
- | DtoFormulario | + | |
+ | **DtoFormulario** | ||
a) Descrição: | a) Descrição: | ||
+ | |||
Objeto que representa um formulário ativo, identificando suas seções e campos passíveis de recebimento da informação. Quando um nova versão do formulário para determinado tipo de formulário for lançada as informações abaixo podem ser atualizada, dada a natureza dinâmica de todo formulário, | Objeto que representa um formulário ativo, identificando suas seções e campos passíveis de recebimento da informação. Quando um nova versão do formulário para determinado tipo de formulário for lançada as informações abaixo podem ser atualizada, dada a natureza dinâmica de todo formulário, | ||
b) Propriedades: | b) Propriedades: | ||
+ | |||
i) Id*: Numero identificador do formulário. | i) Id*: Numero identificador do formulário. | ||
Linha 631: | Linha 628: | ||
* Campos obrigatórios para o Envio de um formulário. | * Campos obrigatórios para o Envio de um formulário. | ||
- | DtoSecao | + | |
+ | **DtoSecao** | ||
a) Descrição: | a) Descrição: | ||
+ | |||
Objeto organizador dos campos que formam um formulário. É na seção que se identifica se os campos são usados apenas para uma retificação e se a seção é do tipo lista, aceitando mais de uma linha durante o envio da informação. | Objeto organizador dos campos que formam um formulário. É na seção que se identifica se os campos são usados apenas para uma retificação e se a seção é do tipo lista, aceitando mais de uma linha durante o envio da informação. | ||
Linha 638: | Linha 638: | ||
b) Propriedades: | b) Propriedades: | ||
+ | |||
i) Id: Numero identificador da seção. | i) Id: Numero identificador da seção. | ||
Linha 648: | Linha 649: | ||
v) Campos: Lista com todos os campos desta seção. Este Dto é esclarecido abaixo. | v) Campos: Lista com todos os campos desta seção. Este Dto é esclarecido abaixo. | ||
- | DtoCampo | + | **DtoCampo** |
a) Descrição: | a) Descrição: | ||
+ | |||
Objeto que contêm todas as informação de um campo, que será utilizado tanto para o Envio da Informação, | Objeto que contêm todas as informação de um campo, que será utilizado tanto para o Envio da Informação, | ||
b) Propriedades: | b) Propriedades: | ||
+ | |||
i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar uma informação. | i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar uma informação. | ||
Linha 662: | Linha 666: | ||
v) Ordem: Identifica qual é a posição do campo ao exibir para o usuário na tela. | v) Ordem: Identifica qual é a posição do campo ao exibir para o usuário na tela. | ||
+ | |||
vi) Sequencia*: | vi) Sequencia*: | ||
+ | |||
vii) Valor*: | vii) Valor*: | ||
+ | |||
viii) Md5Arquivo: | viii) Md5Arquivo: | ||
* Campos obrigatórios para o Envio de um formulário. | * Campos obrigatórios para o Envio de um formulário. | ||
- | EnumTipoDado | + | |
+ | **EnumTipoDado** | ||
a) Descrição: | a) Descrição: | ||
Enumerador com todas as opções possíveis para o tipo do Campo. | Enumerador com todas as opções possíveis para o tipo do Campo. | ||
b) Opções: | b) Opções: | ||
+ | |||
i) Texto (1) - Tipo texto. | i) Texto (1) - Tipo texto. | ||
Linha 698: | Linha 708: | ||
xiv) CpfOuCnpj (14) - Tipo CPF ou CNPJ, sem formação. | xiv) CpfOuCnpj (14) - Tipo CPF ou CNPJ, sem formação. | ||
- | DtoArquivo | + | |
+ | **DtoArquivo** | ||
a) Descrição: | a) Descrição: | ||
Objeto que representa um campo do tipo arquivo. | Objeto que representa um campo do tipo arquivo. | ||
Linha 704: | Linha 716: | ||
b) Propriedades: | b) Propriedades: | ||
+ | |||
i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar um arquivo. | i) Id*: Identificador único do Meta Campo, que é obtido na Consulta de formulário e sempre deve ser informado ao enviar um arquivo. | ||
Linha 713: | Linha 726: | ||
* Campos obrigatórios para o Envio de um formulário. | * Campos obrigatórios para o Envio de um formulário. | ||
- | DtoInformação | + | |
+ | **DtoInformação** | ||
a) Descrição: | a) Descrição: | ||
+ | |||
Objeto que representa uma informação, | Objeto que representa uma informação, | ||
b) Propriedades: | b) Propriedades: | ||
+ | |||
i) Id*: Número do informação caso ela já tenha sido enviada anteriormente. | i) Id*: Número do informação caso ela já tenha sido enviada anteriormente. | ||