Especificação do WCF Balcão Versão 0.11

Transcrição

1 Especificação do WCF Balcão 2020 Versão

2 Balcão 2020 Especificação do WCF Versão 0.11 Lisboa, 15 Janeiro 2015 Av. D. João II, Lote Parque das Nações Lisboa. Portugal Tel Fax

3 1. Gestão do documento Versão Data Responsável 0.1 Versão Draft 27/08/2014 André Rodrigues 0.2 Versão Draft 03/09/2014 André Rodrigues 0.3 Versão Draft 13/09/2014 André Rodrigues 0.4 Versão Draft 24/11/2014 André Rodrigues 0.5 Versão Draft 25/11/2014 Bruno Bento 0.6 Versão Draft 27/11/2014 Bruno Bento 0.7 Versão Draft 27/11/2014 Bruno Bento 0.8 Versão Draft 27/11/2014 André Rodrigues 0.9 Versão Draft 07/01/2015 André Rodrigues 0.10 Versão Draft 9/01/2015 André Rodrigues 0.11 Versão Draft 9/01/2015 André Rodrigues 3

4 2. Sumário de Versões Versão Registo de Alterações 0.1 Especificação inicial do WCF Detalhe apenas para Avisos de Concurso e Candidaturas 0.2 Revisão da AD&C 0.3 Adição dos métodos externos 0.5 Atualização 0.5 Alterações às entidades Avisos de Concurso e Candidatura 0.6 Especificação das entidades de Contrato e Conta Corrente Atualização de Tabelas de domínio Adição de dicionário de mensagens 0.7 Especificação de Objeto de Listagem 0.8 Concursos Multi NUT Candidaturas / Indicadores Novos campos Conta-corrente Novos campos 0.9 Correcções / Atualização 0.10 Atualização 4

5 Versão Registo de Alterações 0.11 Atualização Novos campos: - url (concurso) -criar_conta_corrente (concurso) -anoalvo (candidatura) 5

6 3. Especificação dos métodos Este documento deve ser complementado com o Anexo I composto pela lista detalhada de tabelas domínio. É de referir que a todos os métodos se acrescenta os parâmetros username e password de forma a garantir a autenticação dos pedidos Avisos de concurso Criar/Alterar O WCF recebe um objeto [Aviso] e devolve uma lista resultado de IDs de mensagens de validação sobre o [Aviso] a criar/editar Listar O WCF recebe os seguintes parametros de pesquisa: cod_concurso programa_operacional eixo_prioritario data_inicio_edicao data_fim_edicao e devolve uma lista simplificada de objetos [AvisoPesquisa] com os seguintes campos preenchidos: cod_concurso designacao programa_operacional eixo_prioritario data_edicao Obter O WCF recebe um código de concurso e devolve o objeto [Aviso] correspondente 6

7 3.1.4 Objeto Aviso cod_concurso varchar(50) S Código do concurso. Designacao varchar(300) S Designação do concurso cod_programa_operacional varchar(2) S Código de Programa Operacional cod_eixo_prioritario varchar(2) S Código de Eixo Prioritário cod_objetivo_tematico varchar(2) S Objetivo Temático cod_prioridade_investimento varchar(3) S Prioridade Investimento cod_tipologia_intervencao varchar(3) S Tipologia de Intervenção cod_fundo varchar(2) S Codigo do Fundo cod_plano_estrategico varchar(2) N Plano Estratégico descricao varchar(4000) S Descrição do Concurso cod_tipo_concurso varchar(2) S Código do Tipo do Concurso data_publicacao Datetime S Data da Publicação data_inicio Datetime S Início do período em que é possível submeter candidaturas enquadradas neste aviso/convite; data e hora 7

8 data_conclusao Datetime S Limite temporal em que é possível submeter candidaturas enquadradas neste aviso/convite; data e hora Dotacao decimal(18, 2) N Dotação taxa_max_comparticipacao decimal(5, 2) N Taxa máxima de comparticipação montante_max_comparticipacao decimal(18, 2) N Montante máximo comparticipação Fases Varchar(150) N Identifica uma 2ª fase do aviso inicial, conforme já ocorre nos concursos SI Concurso_Ambito_Territorial Objeto S Lista data_previsao_decisao_final Datetime N Data Prevista para a Decisão final sobre candidaturas tempo_medio_decisao Int N Tempo médio de decisão entidade_responsavel Int S Entidade Responsável Contacto varchar(1000) S cod_abordagem_territorial varchar(2) S Abordagem Territorial cod_forma_financiamento varchar(2) S Forma de Financiamento numero_candidaturas_beneficiari o Int N Número máximo de candidaturas que o aviso permite submeter. Null para não definir limite. cod_estado Int S Estado do Concurso registo_user varchar(50) S Último utilizador editor do concurso 8

9 registo_data Datetime S Última data de edição do concurso url_candidatura varchar(1000) N URL da candidatura (sistema externo) candidatura_conta_corrente bit S Decisão se o click no link da candidatura externa gera entrada em conta-corrente Concurso_Entidades_Beneficiaria s Objeto N Lista Concurso_Cae Objeto N Lista Concurso_Indicadores Objeto S Lista Concurso_Nif_Entidades Objeto N Lista Concurso_Palavras_Chave Objeto S Lista Concurso_Campos_Dinamicos Objeto N Lista Concurso_Documento Objeto S Lista Lista com todos os tokens de ficheiros associados ao Concurso. Se um token deixar de existir, significa que foi desassociado Objeto Concurso_Ambito_Territorial cod_concurso Varchar(50) S Código do concurso cod_ambito_territorial Varchar(2) S NUT Objeto Concurso_Entidades_Beneficiarias 9

10 cod_concurso Varchar(50) S Código do concurso Entidade_beneficiaria Varchar(2) S Entidade Beneficiária BLC_Pessoa Objeto Concurso_Cae cod_concurso Varchar(50) S Código do concurso cod_cae Varchar(5) S Código CAE Objeto Concurso_Indicadores cod_concurso Varchar(50) S Código do concurso cod_indicador Varchar(2) S Código do indicador Designacao Varchar(50) N Objeto Concurso_Nif_Entidades cod_concurso Varchar(50) S Código do concurso nif_beneficiario Varchar(20) S NIF Objeto Concurso_Palavras_Chave cod_concurso Varchar(50) S Código do concurso 10

11 cod_palavra_chave Varchar(50) S Código da palavra-chave Objeto Concurso_Campos_Dinamicos cod_concurso Varchar(50) S Código do concurso cod_campo_dinamico Varchar(50) S Código do Campo Dinâmico Designacao Varchar(50) N Objeto Concurso_Documentos id_documentotoken Varchar(50) S Identificador de Documento cod_concurso Varchar(50) S Código do concurso cod_tipo_documento Int S Código do Tipo do Documento 3.2. Candidaturas Alterar O WCF recebe um objeto [Candidatura] e devolve uma lista resultado de IDs de mensagens de validação sobre a candidatura a alterar Listar O WCF recebe os seguintes parâmetros de pesquisa: num_candidatura cod_operacao 11

12 cod_concurso cod_programa_operacional (do concurso) 12legível12o cod_estado_candidatura data_inicio_edicao data_fim_edicao e devolve uma lista simplificada de objetos [CandidaturaPesquisa] com os seguintes campos preenchidos: num_candidatura cod_operacao 12legível12o data_edicao cod_estado_candidatura Obter O WCF recebe um número de candidatura e devolve o objeto [Candidatura] correspondente Objeto Candidatura num_candidatura Int S Número da Candidatura cod_operacao varchar(50) N Código Universal da Operação cod_concurso varchar(50) S Código do Concurso Designacao varchar(200) S Designação da Operação Descricao varchar(4000) S Descrição sumária da operação Objetivos varchar(4000) S Objetivos da Operação 12

13 Resumo varchar(450) N Resumo estado_atual_trabalhos varchar(4000) S Estado Atual dos Trabalhos data_prevista_inicio Datetime S Data prevista de Início data_prevista_conclusao Datetime S Data prevista de Conclusão Candidatuta_Localizacao Objeto S Lista cod_natureza_invest S Natureza do Investimento 13legível13o_economica Bit S Com utilização económica cod_cae varchar(5) S CAE/Setor de Atividade da operação cod_categoria_intervencao varchar(9) S Domínio de Intervenção medidas_publicidade varchar(4000) N Medidas de publicidade nome_responsavel varchar(500) S Nome do responsável telefone_responsavel varchar(20) S Telefone do responsável cargo_responsavel varchar(50) S Cargo do responsável 13legível13_responsavel varchar(20) N Telemóvel do responsável 13legíve_departamento varchar(50) S Serviço/Departamento _responsavel varchar(100) S do responsável _alternativo varchar(100) N alternativo 13

14 qren_ambito Bit S No âmbito do QREN qren_ambito_continuacao varchar(1000) N Identificar códigos operações qren_ambito_complementar varchar(1000) N Identificar códigos operações qren_ambito_pt_2020 Bit S No âmbito do Portugal 2020 qren_ambito_pt_2020_conti nuacao varchar(1000) N Identificar códigos operações qren_ambito_pt_2020_comp lementar varchar(1000) N Identificar códigos operações qren_ambito_pt_2020_fse varchar(1000) N Identificar códigos operações qren_ambito_outros Bit S No âmbito de outros Programas Nacionais ou Comunitários qren_ambito_outros_continu acao varchar(1000) N Identificar códigos operações / descrição qren_ambito_outros_comple mentar varchar(1000) N Identificar códigos operações / descrição custo_total decimal(18, 2) S Custo Total Deverá ser igual à soma do custo total dos componentes investimento_nao_elegivel decimal(18, 2) S Investimento Não Elegível Deverá ser igual à soma do Investimento Não Elegível dos Componentes inv_elegivel_nao_compartici pado decimal(18, 2) S Investimento Elegível Não Comparticipado investimento_elegivel decimal(18, 2) A Investimento Elegível Deverá ser igual à soma do Investimento Elegível dos Componentes 14legível_geradora_receitas Bit S Operação Geradora Receitas custo_total_actualizado decimal(18, 2) S Custo Total Atualizado 14

15 receitas_liquidas_actualizad as decimal(18, 2) S Receitas Líquidas Atualizadas despesas_elegiveis decimal(18, 2) A Despesas Elegiveis Igual à diferença entre o Custo Total Atualizado e as Receitas Líquidas Atualizadas 15legív_financiamento decimal(18, 2) A Defice Financiamento Igual ás Despesas Elegiveis a dividir pelo Custo Total Atualizado montante_maximo_elegivel decimal(18, 2) A Montante Máximo Elegível Igual ao Elegível caso a operação não seja geradora de receitas 15legível15o15o_comunitari a decimal(18, 2) S Contribuição Comunitária ou FEDER taxa_cofinanciamento decimal(18, 2) A Taxa Cofianciamento Igual à divisão da Contribuição FEDER pelo Montante Máximo Elegível financiamento_publico_naci onal decimal(18, 2) S Financiamento Público Nacional financiamento_privado decimal(18, 2) S Financiamento Privado fonte_oe_cap50 decimal(18, 2) S Fonte OE Cap50 fonte_oe_cap3 decimal(18, 2) S Fonte OE Cap3 fonte_oe_outras decimal(18, 2) S Fonte OE Outras fonte_oe decimal(18, 2) A Fonte OE Igual ao somatório da Fonte OE Cap50 com Fonte OE Cap3 e Outras Fontes OE fonte_al decimal(18, 2) S Fonte de Autarquia local fonte_ep decimal(18, 2) S Fonte de Empreas Públicas fonte_or decimal(18, 2) S Fonte de Orçamento Regional fonte_ou decimal(18, 2) S Fonte de Outras 15

16 16legív_orcamento_investim ento varchar(50) S Código do Orçamento de Investimento 16legível16o_orcamento_in vestimento varchar(50) S Designação do Orçamento de Investimento Ministerio varchar(50) N Ministério Servico varchar(50) N Serviço recursos_emprestimo_bei Bit S Recurso Empréstimo BEI Indicador de existência recursos_emprestimo_bei_c odigo varchar(50) N Recurso Empréstimo BEI Código recursos_emprestimo_bei_ montante decimal(18, 2) N Recurso Empréstimo BEI Montante recursos_emprestimo_bei_d ata Datetime N Recurso Empréstimo BEI Data cod_estado_candidatura Int S Código do Estado da Candidatura data_estado_candidatura Datetime S Data do Estado da Candidatura registo_data Datetime A Data da criação/edição da Candidatura registo_user varchar(50) A Identificador do Utilizador que criou/editou a Candidatura 16legível_nao_comparticipa do_receitas decimal(18, 2) A Elegível Não Comparticipado das Receitas Igual á diferença entre o Investimento Elegível e o Montante Máximo Elegível total_elegivel_nao_comparti cipado decimal(18, 2) A Total Elegível Não Comparticipado Igual ao somatório do Elegível Não Comparticipado das Receitas com o Investimento Elegível Não Comparticipado Candidatura_ Beneficiario Objeto S Lista 16

17 Candidatura_ Componente Objeto S Lista Candidatura_ Documento Objeto S Lista Candidatura_ Indicador Objeto S Lista Candidatura_ Localizacao Objeto S Lista Candidatura_Reparticao_An ual Objeto S Lista Candidatura_ Campo_Dinamico Objeto N Lista Candidatura_Contrato Objecto N Lista Objeto Candidatura_Beneficiario num_candidatura Int S Número da Candidatura nif_beneficiario varchar(20) S NIF Percentagem decimal(5, 2) S Percentagem Principal Bit S Indicador caso seja o Benef. Principal Objeto Candidatura_Componente num_candidatura Int S Número da Candidatura cod_componente Int S Código da Componente 17

18 nif_beneficiario varchar(50) S NIF custo_total decimal(18, 2) S Custo Total investimento_elegivel decimal(18, 2) A Investimento Elegível investimento_nao_elegivel decimal(18, 2) S Investimento Não Elegível investimento_elegivel_nao_ comparticipado decimal(18, 2) S Investimento Elegível Não Comparticipado Objeto Candidatura_Indicador num_candidatura Int S Número da Candidatura cod_indicador varchar(2) S Código do Indicador exec_fin_contratada decimal(18,2) N Financiamento contratado exec_fin_executada decimal(18,2) N Financiamento executado observacoes varchar(4000) N Observações meta1 decimal(18,2) S Meta 1 valor_referencia decimal(18,2) S Valor Referencia ano_alvo int S Ano Alvo Objeto Candidatura_Localizacao cod_nuts_ii varchar(2) S Código NUT II cod_nuts_iii varchar(3) N Código NUT III 18

19 cod_distrito varchar(2) N Código do Distrito cod_concelho varchar(2) N Código do Concelho cod_freguesia varchar(2) N Código da Freguesia Percentagem decimal(18,2) S Percentagem georreferenciacao varchar(4000) N código19ão19i_terr_invest varchar(50) N Objeto Candidatura_ Reparticao_Anual num_candidatura Int S Número da Candidatura Ano Int S Ano custo_total decimal(18, 2) A Custo Total investimento_elegivel decimal(18, 2) A Investimento Elegível investimento_nao_elegivel decimal(18, 2) S Investimento Não Elegível Investimento_elegivel_nao_ comparticipado decimal(18, 2) S Investimento Elegível Não Comparticipado despesa_publica decimal(18, 2) A Despesa Pública fonte_comunitaria decimal(18, 2) S Fonte FEDER fonte_oe decimal(18, 2) S Fonte OE fonte_al decimal(18, 2) S Fonte AL fonte_ep decimal(18, 2) S Fonte EP 19

20 fonte_or decimal(18, 2) S Fonte OR fonte_ou decimal(18, 2) S Fonte OU fonte_privado decimal(18, 2) S Fonte privada Objeto Candidatura_Campo_Dinamico num_candidatura Int S Número da Candidatura cod_campo_dinamico Int S Código Campo Dinâmico Valor varchar(4000) S Valor Objeto Candidatura _Documentos num_candidatura Int S Número da Candidatura id_documento varchar(50) S Identificador de Documento cod_tipo_documento Int S Código do Tipo do Documento Objeto Candidatura _Contrato num_candidatura Int S Número da Candidatura cod_componente Int S Código do componente nif_beneficiario varchar(50) S NIF do beneficiário 20

21 data_registo datetime S Data do contrato 3.3. Contratos Criar O WCF recebe um objeto [Contrato] e devolve uma lista resultado de IDs de mensagens de validação sobre o [Contrato] a criar/editar Listar O WCF recebe os seguintes parâmetros de pesquisa: cod_contrato nif_entidade_beneficiaria nif_fornecedor data_inicio_contrato data_conclusao_contrato e devolve uma lista simplificada de objetos [ContratoPesquisa] com os seguintes campos preenchidos: id_contrato cod_contrato código21ão21 código21ão fornecedor calculo_investimento procedimento_contratacao data_autorizacao data_adjudicacao data_publicacao 21

22 data_visto valor_base valor_adjudicacao código22_preco iva total_com_iva código22ão22i Obter O WCF recebe um identificador de contrato e devolve o objeto [Contrato] correspondente Objeto Contrato Id Int S Identificador do Contrato cod_contrato varchar(50) S Código do Contrato Designacao varchar(200) S Designacao do Contrato Descricao nvarchar(4000) S Descrição do Contrato data_inicio Datetime S Data Inicio do Contrato data_conclusao Datetime S Data Conclusão do Contrato id_fornecedor Int N Identificador do Fornecedor Tabela Dominio: Fornecedor id_calculo_investimento Int S Identificador do Cálculo de Investimento data_publicacao_joue Datetime S Data de Publicação no JOUE data_publicacao_basegov Datetime S Data de Publicação no Portal Base.Gov 22

23 data_adjudicacao Datetime Data de Adjudicação Obrigatório se Cálculo de Investimento igual a Valor da Adjudicação data_auto_consignacao Datetime N Data de Auto Consignação data_visto_tribunal_contas Datetime N Data de Visto do Tribunal de Contas id_procedimento_contrataca o int S Identificador do Procedimento de Contratação Tabela de Dominio: ProcedimentoContratacao valor_base decimal(18,2) S Valor Base sem IVA valor_adjudicacao decimal(18,2) Valor de Adjudicação Obrigatório se Calculo Investimento igual a Valor de Adjudicação código23_precos decimal(18,2) S Revisão de Preços Iva decimal(5,2) S Valor do IVA total_com_iva decimal(18,2) A Valor Total é igual ao somatório da Revisão de Preços, do IVA e do Valor da Adjudicação se Cálculo de Investimento é igual a Valor da Adjudicação. Caso contrário, é igual ao somatório da Revisão de Preços, do IVA e do Valor Base sem IVA. Observacoes varchar(450) N Observações ao contrato id_parecer_ag int S Parecer da AG Tabela de Dominio: ParecerAG nif_entidade_beneficiaria varchar(50) A Nif da Entidade Beneficiária ao qual beneficiário pertence registo_user varchar(50) S Identificador do uitilizador registo_data datetime S Data de edição do Contrato 23

24 Contrato_Empreitada Objeto N Lista Contrato_Documento Objeto N Lista Contrato_CandidaturaComp onente Objeto N Lista Objeto Contrato_Empreitada id_contrato Int S Identificador do Contrato numero_auto_medicao Int S Número de Auto Medição data_auto_medicao datetime S Data de Auto Medição valor_total_auto_medicao Decimal(18,2) S Valor Total de Auto Medição valor_elegivel_auto_medica o Decimal(18,2) S Valor Elegivel de Auto Medição Objeto Contrato_Documento id_contrato Int S Identificador do Contrato id_documento varchar(50) S Identificador do Documento cod_tipo_documento int S Código do Tipo de Documento Objeto Contrato_CandidaturaComponente id_contrato Int S Identificador do Contrato num_candidatura int S Identificador da Candidatura 24

25 cod_documento int S Código do Documento nif_beneficiario varchar(50) S Nif do Beneficiário data_registo datetime S Data da associação 3.4. Pedidos de Pagamento Criar O WCF recebe uma lista de objetos [PedidoPagamento] Listar O WCF devolve uma lista de objetos [PedidoPagamento] 3.5. Documentos Criar O WCF recebe um objeto [Documento] e retorna um token Obter O WCF recebe um token e devolve um objeto [Documento] Objeto Documento Nome varchar(250) S Nome do Ficheiro Bytes byte[] S Bytes do Ficheiro 25

26 3.6. ContaCorrente Criar O WCF recebe um objeto [ContaCorrente] e devolve uma lista resultado de IDs de mensagens de validação sobre o [ContaCorrente] a criar Listar O WCF recebe os seguintes parâmetros de pesquisa: código_operacao código26ão26 nif_entidade_beneficiario e devolve uma lista de objetos [ContaCorrente] Eliminar O WCF recebe um ID e elimina a entrada na [ContaCorrente], correspondente a esse ID Objeto ContaCorrente id varchar(50) S Identificador da ContaCorrente cod_operacao varchar(50) S Código da Operação designacao varchar(200) S Designação cod_estado_candidatura Int S Código do Estado da Candidatura data_estado_candidatura datetime S Data do Estado da Candidatura aprovado_custo_total decimal(18,2) N Custo Total Aprovado aprovado_elegivel decimal(18,2) N Elegível Aprovado aprovado_apoio decimal(18,2) N Apoio Aprovado 26

27 pedpag_apresentados_cust o_total decimal(18,2) N Custo Total dos Pedidos de Pagamento Apresentados pedpag_validados_custo_tot al decimal(18,2) N Custo Total dos Pedidos de Pagamento Validados pedpag_validados_elegivel decimal(18,2) N Elegível dos Pedidos de Pagamento Validados pedpag_validados_nao_ele givel decimal(18,2) N Não Elegível dos Pedidos de Pagamento Validados pedpag_validados_apoio decimal(18,2) N Apoio dos Pedidos de Pagamento Validados pedpag_aguarda_validacao _custo_total decimal(18,2) N Custo Total dos Pedidos de Pagamento a Aguardar Validação apoio_pago decimal(18,2) N Apoio Pago apoio_validado_pagar decimal(18,2) A Apoio Validado a Pagar registo_user varchar(50) S User de Registo nif_entidade_benef varchar(50) S Nif Entidade Beneficiária código_programa varchar(50) S Código do Programa Operacional URL varchar(2500) N URL codigo_concurso varchar(50) S Código do Concurso codigo_programa varchar(50) S Código do Programa 27

28 4. Tratamento de Excepções Todos os métodos retornam o tipo ServiceResult O tipo ServiceResult tem duas propriedades: OK: boolean Errors: IDictionary<string, string> ( chave do erro, mensagem de erro ) Existe ainda uma propriedade adicional, quando o método retorna algo. Nesse caso o ServiceResult terá mais uma propriedade do tipo definido para o retorno Mensagens de Erro Ver Anexo I 28

29 5. Tabelas Domínio Ver Anexo I 29