Sistema Integrado de Controle de Obras Públicas€¦ · obras, possam enviar seus dados para...

Sistema Integrado de Controle de Obras Públicas www.sicop.sc.gov.br

1

Sistema Integrado de Controle de Obras Públicas

Definição das regras de integridade, negócio e relacionamento do Web Service SICOP


2

ÍNDICE

1. Apresentação _______________________________________________________________________ 5

1.1. Serviços __________________________________________________________________________ 5

1.2. Autenticação ______________________________________________________________________ 5

1.3. Objetos XML ______________________________________________________________________ 6

1.4. Validação – Arquivos XSD ____________________________________________________________ 6

1.5. Competência ______________________________________________________________________ 6

2. Principais funcionalidades do wsSICOP __________________________________________________ 7

2.1. Cadastros ________________________________________________________________________ 7

2.2. Cadastros de Pagamentos ___________________________________________________________ 7

2.3. Listagens _________________________________________________________________________ 8

3. Detalhamento das funcionalidades ____________________________________________________ 10

3.1. Manter Contratada ________________________________________________________________ 10

3.2. Manter Contrato __________________________________________________________________ 10

3.3. Manter Obra _____________________________________________________________________ 10

3.4. Manter Foto _____________________________________________________________________ 11

3.5. Manter Serviço ___________________________________________________________________ 11

3.6. Manter Aditivo ___________________________________________________________________ 11

3.7. Manter Paralisação ________________________________________________________________ 11

3.8. Manter Rescisão __________________________________________________________________ 11

3.9. Manter Medição __________________________________________________________________ 11

3.10. Manter Bem Público _____________________________________________________________ 12

3.11. Manter Recebimento Provisório____________________________________________________ 12

3.12. Manter Recebimento Definitivo ____________________________________________________ 12

3.13. Manter Reajuste Medição ________________________________________________________ 12

3.14. Manter Pagamento ______________________________________________________________ 12

3.15. Funcionalidade Listar Objetos _____________________________________________________ 12

3.16. Relação de Objetos XML __________________________________________________________ 13

4. Detalhamento dos Objetos XML do web service - SICOP ____________________________________ 14

4.1. Web service SICOP- Contratada ______________________________________________________ 14 4.1.1. Objeto XML Contratada ______________________________________________________________ 14

4.2. Web service SICOP- Contrato ________________________________________________________ 15


3

4.2.1. Objeto XML Contrato _________________________________________________________________ 16 4.2.2. Objeto XML Edital ___________________________________________________________________ 19 4.2.3. Objeto XML Dotação _________________________________________________________________ 20

4.3. Web service SICOP- Obra ___________________________________________________________ 21 4.3.1. Objeto XML Obra ____________________________________________________________________ 21 4.3.2. Objeto XML Fiscal ___________________________________________________________________ 22 4.3.3. Objeto XML ART ____________________________________________________________________ 23 4.3.4. Objeto XML MunicipioObra ___________________________________________________________ 25

4.4. Web service SICOP- TituloFoto _______________________________________________________ 26 4.4.1. Objeto XML TituloFoto _______________________________________________________________ 26

4.5. Web service SICOP- Serviço _________________________________________________________ 27 4.5.1. Objeto XML ServicoContratoObra _____________________________________________________ 27

4.6. Web service SICOP- Aditivo _________________________________________________________ 28 4.6.1. Objeto XML Aditivo __________________________________________________________________ 28

4.7. Web service SICOP- ServicoAditivo ___________________________________________________ 29 4.7.1. Objeto XML ServicoAditivo ___________________________________________________________ 29

4.8. Web service SICOP- Paralisação ______________________________________________________ 31 4.8.1. Objeto XML Paralisação ______________________________________________________________ 31

4.9. Web service SICOP- ParalisacaoFoto __________________________________________________ 32 4.9.1. Objeto XML ParalisacaoFoto __________________________________________________________ 32

4.10. Web service SICOP- Rescisão ______________________________________________________ 33 4.10.1. Objeto XML Rescisão ______________________________________________________________ 33 4.10.2. Objeto XML MotivoRescisao ________________________________________________________ 34

4.11. Web service SICOP- Medição ______________________________________________________ 34 4.11.1. Objeto XML Medição _______________________________________________________________ 34 4.11.2. Objeto XML Comissão de Fiscalização (FISCAL) ______________________________________ 36 4.11.3. Objeto XML QuantidadeMedição ____________________________________________________ 36 4.11.4. Objeto XML MedicaoGrupo _________________________________________________________ 37

4.12. Web service SICOP- Bem Público ___________________________________________________ 38 4.12.1. Objeto XML BemPublico ___________________________________________________________ 38 4.12.2. Objeto XML RegistroImovel _________________________________________________________ 39

4.13. Web service SICOP - Recebimento Provisório _________________________________________ 39 4.13.1. Objeto XML RecebimentoProvisorio _________________________________________________ 39

4.14. Web service SICOP- Recebimento Definitivo __________________________________________ 40 4.14.1. Objeto XML RecebimentoDefinitivo __________________________________________________ 40

4.15. Web service SICOP – Pagamento ___________________________________________________ 41 4.15.1. Objeto XML Empenho ______________________________________________________________ 41 4.15.2. Objeto XML Liquidação ____________________________________________________________ 42 4.15.3. Objeto XML Pagamento ____________________________________________________________ 43 4.15.4. Objeto XML Estorno _______________________________________________________________ 44 Detalhamento dos elementos do objeto XML do estorno do empenho ou liquidação:_________________ 44 4.15.5. Objeto XML EstornoPagamento _____________________________________________________ 45 Detalhamento dos elementos do objeto XML do estorno do pagamento: ___________________________ 45


4

4.16. Web servisse SICOP – Reajuste _____________________________________________________ 46 4.16.1. Objeto XML ReajusteMedicao _______________________________________________________ 46 4.16.2. Objeto XML ReajusteMedicaoObra __________________________________________________ 47

4.17. Web service SICOP- Listas _________________________________________________________ 47 4.17.1. Objeto XML Cargo _________________________________________________________________ 47 4.17.2. Objeto XML GrupoServico __________________________________________________________ 48 4.17.3. Objeto XML Indice _________________________________________________________________ 48 4.17.4. Objeto XML Município ______________________________________________________________ 49 4.17.5. Objeto XML Natureza ______________________________________________________________ 49 4.17.6. Objeto XML OrgaoSetor ____________________________________________________________ 49 4.17.7. Objeto XML TipoFotoObra __________________________________________________________ 50 4.17.8. Objeto XML TipoObra ______________________________________________________________ 50 4.17.9. Objeto XML TipoTitulo _____________________________________________________________ 50 4.17.10. Objeto XML UnidadeMedida ________________________________________________________ 51 4.17.11. Objeto XML Cartório _______________________________________________________________ 51 4.17.12. Objeto XML MotivoOcorrencia ______________________________________________________ 51 4.17.13. Objeto XML TipoBemPublico________________________________________________________ 52


5

1. Apresentação

Com o objetivo de facilitar a integração com o SICOP, estamos disponibilizando o seu web service: wsSICOP. Esse web service permite que alguns órgãos que já dispõem de um sistema interno para controle das suas obras, possam enviar seus dados para disponibilizá-los no Sistema Integrado de Controle de Obras Públicas do Estado de Santa Catarina. Assim, além de permitir a centralização dessas informações, esta ferramenta permite que o SOF – Sistema de Execução Financeiro e orçamentário utilize os dados recebidos do SICOP para liberação dos empenhos para pagamento das obras realizadas pelos órgãos e autarquias. Com essas informações será realizada uma segunda integração de dados, desta vez com o sistema e-SFINGE, do Tribunal de Contas de Santa Catarina. Por esses motivos, fica clara a importância do envio dos dados das obras do estado para o SICOP, pois, desse modo, será mantida uma série de serviços importantes para o gerenciamento financeiro das obras do estado. Para realizar essa integração adotamos a tecnologia web service, a qual permite que as aplicações enviem informações por arquivos em formato XML e, também, por ser de um padrão de mercado bem difundido e utilizado. Essa tecnologia é de fácil entendimento e utilização e, principalmente, independente de tecnologia de desenvolvimento e de plataforma. A utilização de web service também se justifica pelo fato de integrar os dados com o TCE/SC, que utiliza a mesma tecnologia, mantendo uma compatibilidade na importação de dados.

1.1. Serviços

O wsSICOP disponibiliza vários serviços que permitem incluir, excluir, consultar e listar objetos XML. Por exemplo, para incluir uma empresa contratada, deve-se utilizar o método do web service com a seguinte chamada:

wsSICOP.IncluirContratada(xmlContratada) Já para excluir uma contratada, pode-se utilizar o método:

wsSICOP.ExcluirContratada(xmlContratada) Este mesmo padrão segue para todos os principais objetos XML, que são descritos logo abaixo.

1.2. Autenticação

Lembramos que antes de realizar qualquer acesso aos serviços disponibilizados pelo web service, deve-se fazer chamada aos métodos setUserName e setPassward para autenticação do usuário, passando o usuário e senha respectivamente. Somente assim os demais métodos serão executados com sucesso. Para melhores esclarecimentos sobre autenticação, verificar no exemplo disponível no site do web service em www.sicop.sc.gov.br/wssicop.

http://www.sicop.sc.gov.br/wssicop


6

1.3. Objetos XML

Os objetos XML, que são relacionados no item 3.16 e detalhados no item 4, são utilizados para enviar as respectivas informações por meio dos métodos disponibilizados pelo web service. Esses objetos XML possuem os campos necessários para inclusão das informações na base de dados do SICOP. O objeto XML pode ser utilizado por todos os métodos da respectiva classe. Por exemplo, o objeto XML Contratada pode ser utilizado pelos métodos IncluirContratada, ExcluirContratada e ConsultarContratada. Para os métodos excluir e consultar, os objetos XML devem ser passados somente com os campos-chave (identificador) da classe. No caso da contratada, seria o elemento cdContratada. Cada objeto XML a ser enviado via web service corresponde, em geral, a alguma janela do sistema SICOP. Os campos a serem preenchidos na tela correspondem aos atributos do objeto. Todas as operações são uma transação única. Se houver problema na operação, esta será cancelada. Por exemplo, se for enviado um lote com cinco objetos e um deles apresentar problema, nenhum deles será inserido no sistema. Outra observação importante é que não há transação entre chamadas dos serviços. Por exemplo, se for executado um serviço com sucesso inserindo três objetos e, em seguida, outro serviço com problema, os primeiros três objetos não serão cancelados. As informações podem ser basicamente dos tipos string, int, double e date. Os tipos de dados string e int possuem somente o atributo para especificar seu tamanho; o tipo de dado double, além da especificação do tamanho, também possui o atributo para especificar o formato, permitido, neste caso, que possa haver variação, dependendo do campo; o tipo de dado date possui um tamanho e um formato específico para todos os campos de data.

1.4. Validação – Arquivos XSD

Além dos métodos para manutenção dos dados no SICOP, também serão disponibilizados arquivos em formato XSD para que o cliente do web service realize uma validação dos dados antes de enviá-los. Desse modo, evita-se o reenvio de arquivos inválidos.

1.5. Competência

A competência é um artifício utilizado pelo e-SFINGE para fazer o controle da manutenção dos dados recebidos. Por exemplo, um contrato enviado em uma determinada competência não poderá mais ser alterado ou excluído quando essa competência for substituída por outra. Sendo assim, o SICOP também tem que utilizar esse tipo de controle para manter a compatibilidade com o e-SFINGE. Ou seja, os dados enviados em um período serão automaticamente vinculados à última competência aberta no e-SFINGE e somente poderão ser excluídos enquanto esta estiver vigente.


7

2. Principais funcionalidades do wsSICOP

2.1. Cadastros

O seguinte diagrama de use case representa as principais funcionalidades de cadastramento disponibilizadas pelo wsSICOP:

2.2. Cadastros de Pagamentos

O seguinte diagrama de use case representa as funcionalidades de cadastramento disponibilizadas pelo wsSICOP quando não usado o Sistema Integrado de Planejamento e Gestão Fiscal (SIGEF):


8

2.3. Listagens

O seguinte diagrama de use case representa as listagens disponibilizadas pelo wsSICOP:


9


10

3. Detalhamento das funcionalidades

3.1. Manter Contratada

Esta funcionalidade permite ao cliente do serviço incluir, excluir e consultar uma empresa contratada. Para utilizar essas funcionalidades, deve-se fazer a chamada remota a um dos métodos acima, passando como parâmetro o objeto XML Contratada, que é descrito no item 4.1.1. Esse deve ser o primeiro passo a ser realizado para inclusão de um contrato e obra no SICOP. Depois da inclusão de uma contratada, esta pode ser reutilizada, pois receberá um código identificador, representado pelo elemento cdContratada do objeto XML contratada. O elemento nuCGCCPF pode ser utilizado para consultar uma determinada contratada, juntamente com o elemento tpContratada. Para se obter o código do município, necessário para a inclusão da contratada, deve-se utilizar a consulta de município pelo método wsSICOP.ListarMunicipio().

3.2. Manter Contrato

Permite que o cliente do serviço inclua, exclua e consulte um contrato no SICOP. Para isso, devem ser utilizados os objetos XML Contrato, Edital e Dotação, que são descritos nos itens 4.2.1, 4.2.2 e 4.2.3 respectivamente. Assim, esse serviço irá incluir também os dados do edital e dotação orçamentária juntamente com o contrato. Antes de proceder à inclusão de um contrato, deve-se realizar a inclusão da empresa contratada, descrita no item anterior. O código interno da contratada (cdContratada) é retornado no momento de sua inclusão, mas também pode ser recuperado por meio do método wsSICOP.ConsultarContratada(). Para o preenchimento dos elementos cdSetor, cdSetorBenef, cdSetorSolict, cdEspTitulo do objeto XML Contrato, deve-se obter os códigos por intermédio das respectivas consultas, conforme descrito no item 4.2.1. Depois da inclusão de um contrato, este pode ser identificado pelo código gerado internamente e descrito no elemento nuTitulo do objeto XML Contrato. A consulta desse objeto também pode ser realizada por meio do elemento cdTitulo deste objeto XML. Ao realizar a consulta do contrato por intermédio do web service, serão retornados todos os objetos XML relacionados ao contrato. O objeto XML Contrato deve ser o segundo a ser incluído no sistema, pois os demais objetos dependem dele para serem incluídos.

3.3. Manter Obra

Este serviço permite ao usuário incluir, excluir e consultar os dados das obras, dos fiscais da obra, das ARTs e dos municípios atendidos pela obra. Ele recebe os objetos XML Obra, Fiscal, ART e MunicipioObra, descritos nos itens 4.3.1, 4.3.2, 4.3.3, 4.3.4 respectivamente. Depois da inclusão de uma obra e seus objetos XML associados, ela pode ser identificada pelos elementos internos nuTitulo e cdLote. Desse modo, para realizar a consulta ou a exclusão de uma obra deve-se enviar


11

um objeto XML Obra com esses dois elementos preenchidos. O elemento nuTitulo pode ser recuperado por meio da consulta de contrato wsSICOP.ConsultarContrato().

3.4. Manter Foto

Este serviço permite ao usuário incluir, excluir e consultar os dados das fotos dos contratos. Para realizar a inclusão das fotos o cliente deve enviar um objeto XML TituloFoto. Esse objeto XML necessita do preenchimento do campo nuTitulo e pode ser obtido por intermédio da consulta de contrato no web service. Também é necessário o preenchimento do campo tpFoto, que pode ser obtido na consulta wsSICOP.ListarTipoFoto().

3.5. Manter Serviço

Esta funcionalidade permite incluir, excluir e consultar os serviços de um determinado contrato/obra. Para enviar o objeto XML ServicoContratoObra, deve-se primeiramente obter os campos nuTitulo, cdLote e cdGrupoServico que podem ser obtidos, respectivamente, nos métodos wsSICOP.ConsultarContrato(), wsSICOP.ConsultarObra e wsSICOP.ListarGrupoServico(). Os campos cdUnidMedida e cdIndice também devem ser obtidos em suas respectivas listagens para inclusão do serviço.

3.6. Manter Aditivo

Esta funcionalidade permite cadastrar os aditivos de um contrato. Para realizar a inclusão, exclusão e consulta de um aditivo deve-se utilizar o objeto XML Aditivo. Esse objeto XML necessita do preenchimento do campo nuTitulo que pode ser obtido na consulta de contrato.

3.7. Manter Paralisação

Esta funcionalidade permite cadastrar uma paralisação para um contrato. Para realizar a inclusão, exclusão e consulta de uma paralisação deve-se utilizar o objeto XML Paralisação. Esse objeto XML possui o campo nuTitulo que deve ser previamente preenchido e pode ser obtido na consulta de contrato.

3.8. Manter Rescisão

Esta funcionalidade permite cadastrar uma rescisão para um contrato. Para realizar a inclusão, exclusão e consulta de uma rescisão deve-se utilizar o objeto XML Rescisão. Esse objeto XML possui o campo nuTitulo que deve ser previamente preenchido e pode ser obtido na consulta de contrato.

3.9. Manter Medição

Este serviço permite ao usuário incluir, excluir e consultar as medições do contrato, a comissão de fiscalização da medição, as quantidades executadas e os grupos da medição. Para essas operações são utilizados os objetos XML Medição, Fiscal, QuantidadeMedição e MediçãoGrupo que são descritos, respectivamente, nos itens 4.11.1, 4.11.2, 4.11.3 e 4.11.4. Depois da inclusão de uma medição e seus objetos XML associados, ela pode ser identificada pelos elementos internos nuTitulo e nuMedicao. Assim, para realizar a consulta ou a exclusão de uma medição deve-se enviar um objeto XML Medição com esses dois elementos preenchidos. O elemento nuTitulo pode ser recuperado por intermédio da consulta de contrato wsSICOP.ConsultarContrato().


12

3.10. Manter Bem Público

Este serviço permite ao usuário incluir, excluir e consultar os bem públicos. Para essas operações é utilizado o objeto XML BemPublico que é descrito no item 4.12. Depois da inclusão de um bem público, ele pode ser identificado pelo elemento interno nuBemPublico. Assim, para realizar a consulta ou a exclusão de um bem público deve-se enviar um objeto XML BemPublico com esse elemento preenchido. O elemento nuBemPublico pode ser recuperado por intermédio da consulta de contrato wsSICOP. ConsultarBemPublico(). Os dados do registro do imóvel também devem ser inseridos por este método, para tanto deve ser enviado um objeto XML RegistroImovel juntamente com o bem público vinculado.

3.11. Manter Recebimento Provisório

Este serviço permite ao usuário incluir, excluir e consultar a ocorrência do recebimento provisório do contrato. Para essas operações é utilizado o objeto XML RecebimentoProvisório que é descrito no item.

3.12. Manter Recebimento Definitivo

Este serviço permite ao usuário incluir, excluir e consultar a ocorrência do recebimento definitivo do contrato. Para essas operações é utilizado o objeto XML RecebimentoDefinitivo que é descrito no item.

3.13. Manter Reajuste Medição

Permite incluir e consultar o reajuste das medições anteriormente cadastradas. Não tem a opção de excluir e a opção de inclusão permitirá a atualização do valor do reajuste caso seja enviado um valor errado para algum reajuste. O reajuste será sempre por obra, nunca por serviço.Deverá ser enviado em conjunto os itens XML ReajusteMedicao e XML ReajusteMedicaoObra.

3.14. Manter Pagamento

Permite incluir, consultar e realizar o estorno de pagamentos das medições e reajustes sem diferenciar o tipo de pagamento. Para esta operação é utilizado os objetos XML Empenho, XML Liquidação, XML Pagamento, XML Estorno e XML EstornoPagamento.

3.15. Funcionalidade Listar Objetos

A funcionalidade listar os dados internos do web service, permite que o cliente do web service obtenha uma relação de qualquer objeto XML que não possua uma opção para inclusão de dados no web service. Ao realizar uma chamada remota a um método listar de um objeto XML, esse objeto será retornado como resposta à chamada do método. O cliente pode utilizar essa listagem de duas formas: vinculando os códigos recebidos aos seus códigos internos, facilitando, assim, os futuros envios de dados ao web service, pois já possui previamente os códigos desejados; ou, o que não é recomendado, sempre que for realizar um novo envio de dados, buscar os códigos desejados no momento da geração dos objetos XML. A relação de listagens existentes e seus respectivos objetos são detalhados a partir do item 4.17.


13

3.16. Relação de Objetos XML Objeto XML Serviços do wsSICOP

Aditivo IncluirAditivo(), ExcluirAditivo() e ConsultarAditivo()

ART IncluirObra(), ExcluirObra() e ConsultarObra()

Cargo ListarCargo()

Contratada IncluirContratada(), ExcluirContratada() e ConsultarContratada()

Contrato IncluirContrato(), ExcluirContrato() e ConsultarContrato()

Edital IncluirContrato(), ExcluirContrato() e ConsultarContrato()

Fiscal IncluirContrato(), ExcluirContrato() e ConsultarContrato() IncluirMedicao(), ExcluirMedicao() e ConsultarMedicao()

GrupoServico ListarGrupoServico()

Indice ListarIndice()

Medicao IncluirMedicao(), ExcluirMedicao() e ConsultarMedicao()

MedicaoGrupo IncluirMedicao(), ExcluirMedicao() e ConsultarMedicao()

Municipio ListarMunicipio()

MunicipioLote IncluirObra(), ExcluirObra() e ConsultarObra()

Natureza ListarNatureza()

Obra IncluirObra(), ExcluirObra() e ConsultarObra()

Dotação IncluirContrato(), ExcluirContrato() e ConsultarContrato()

OrgaoSetor ListarOrgaoSetor() e ListarBeneficiado()

Paralisacao IncluirParalisacao (), ExcluirParalisacao () e ConsultarParalisacao ()

ParalisacaoFoto IncluirParalisacaoFoto (), ExcluirParalisacaoFoto() e ConsultarParalisacaoFoto()

QuantidadeMedicao IncluirMedicao(), ExcluirMedicao() e ConsultarMedicao()

Rescisao IncluirRescisao (), ExcluirRescisao () e ConsultarRescisao ()

ServicoContratoLote IncluirServico(), ExcluirServico() e ConsultarServico()

ServicoAditivo IncluirServicoAditivo(), ExcluirServicoAditivo () e ConsultarServicoAditivo ()

TipoBempublico ListarTipoBempublico()

TipoFotoObra ListarTipoFoto()

TipoObra LsitarTipoObra()

TipoTitulo ListarTipoTitulo()

TituloFoto IncluirTituloFoto(), ExcluirTituloFoto(), CosultarTituloFoto()

UnidadeMedida ListarUnidadeMedida()

BemPublico IncluirBemPublico(), ExcluirBemPublico(), CosultarBemPublico()

RegistroImoveis IncluirBemPublico(),ExcluirBemPublico(), ConsultarBemPublico()

Cartorio ListarCartorio()

ReajusteMedicao IncluirReajuste(), ConsultarReajuste.

Pagamento IncluirPagamento(), EstornarPagamento() e ConsultarPagamento().

EARoot/EA3/EA1/EA72.htm






































14

4. Detalhamento dos Objetos XML do web service - SICOP

4.1. Web service SICOP- Contratada

4.1.1. Objeto XML Contratada

Detalhamento dos elementos do objeto XML para a contratada. Esse objeto será utilizado pelos métodos IncluirContratada, ExcluirContratada e ConsultarContratada. A contratada é a empresa que irá executar a obra.

Atributos Detalhes

private Integer cdContratada

Notes: Tamanho=7 Nome=Identificador Descrição=código da empresa contratada. Identificador

único do objeto. É definido na inclusão do mesmo. Pode ser utilizado para consulta do objeto.

private String nuCGCCPF

Notes: Tamanho=50 Nome=CPF/CNPJ. Descrição=número do CPF (pessoa física) ou CNPJ (pessoa jurídica). caso tpContratada seja igual a ‘J’ recebe um CNPJ válido caso tpContratada seja igual a ‘F’ recebe um CPF válido

private String nmContratada

Notes: Tamanho=150 Nome=Nome da empresa Descrição=nome completo da empresa contratada (razão social)

private String tpContratada

Notes: in(‘F’, ‘J’) Nome=Tipo de contratada. Descrição=informe o tipo de contratada. F=Pessoa Física J=Pessoa Jurídica

private Integer cdMunicipio

Notes: Tamanho=5 Nome=Município. Descrição=código do município. Pesquisar dados no wsSICOP.ConsultarMunicipio

private Integer cdTipoEndereco

Notes: Tamanho=3 Nome=Tipo de endereço Descrição=informe o tipo de endereço (1-Comercial, 2-Residencial ou 3-Filial).

private String nmRua

Notes: Tamanho=50 Nome=Logradouro Descrição=nome do logradouro.

private String nmBairro

Notes: Tamanho=50 Opcional Nome=Bairro. Descrição=nome do bairro correspondente.


15

private Integer nuNumero

Notes: Tamanho=10 Opcional Nome=Número Descrição= número do endereço.

private String deComplemento

Notes: Tamanho=50 Opcional Nome= Complemento. Descrição=complementação do endereço.

private Integer nuCep

Notes: Tamanho=8 Opcional Nome=CEP. Descrição=Código de Endereçamento Postal correspondente. Mask=somente números, sem máscara.

private String nuRamal

Notes: Tamanho=10 Opcional Nome=Ramal Descrição=número do ramal.

private String nuTelefone

Notes: Tamanho=25 Opcional Nome=Telefone. Descrição=número do telefone.

private String nuInternet

Notes: Tamanho=50 Opcional Nome=E-mail. Descrição=endereço eletrônico correspondente.

private String nmContato

Notes: Tamanho=50 Opcional se tpContratada='F' Nome=Contato. Descrição=pessoa de contato.

private String nmFantasia

Notes: Tamanho=50 Opcional se tpContratada='F' Nome=Nome fantasia. Descrição=nome fantasia da empresa.

private String nuInscEstadual

Notes: Tamanho=20 Opcional se tpContratada='F' Nome=N° Inscrição Estadual. Descrição=número da inscrição estadual.

private String nuRegistroGeral

Notes: Tamanho=15

Opcional se tpContratada='J' Nome=Registro Geral Descrição= número do RG

4.2. Web service SICOP- Contrato

Possibilita a realização do cadastro de um contrato de obras públicas, fornecendo suas informações básicas, como empresa contratada, setor responsável pela execução do contrato, além da informação de datas


16

relacionadas ao contrato, como data de assinatura, período de vigência e de execução do contrato e data-base, bem como as obras relacionadas ao contrato e a planilha de serviços de cada obra. Os dados do edital do contrato, bem como a dotação orçamentária também podem ser atualizados. Os objetos listados abaixo serão utilizados pelos métodos IncluirContrato, ExcluirContrato e ConsultarContrato

4.2.1. Objeto XML Contrato

Detalhamento dos elementos do objeto XML para o contrato:

Atributos Detalhes

private int nuTitulo

Notes: Tamanho=10 Nome=Contrato Descrição=número do contrato (Identificador).

Identificador único do objeto. É definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto.

private string cdTitulo

Notes: Tamanho=30 Nome=Contrato. Descrição=código do contrato. Mask=XX-99999/YYYYXXXXXXXXXXXXXXXX X para alfanuméricos, 9 para números e YYYY para ano

private string deObjeto

Notes: Tamanho=250 Nome=Objeto. Descrição=descrição detalhada do objeto do contrato que explica a que se refere o contrato.

private string deObjetoResumido

Notes: Tamanho=50 Nome=Bem público. Descrição=descrição do Bem Público (imóvel construído com recursos do estado).

private string flSituacao

Notes: Tamanho=1 Nome=Situação Descrição=Este campo indica a situação do contrato que está sendo cadastrado Valores=(A,C,I) A-Andamento, C-Concluido, I- A Iniciar

private int cdSetor

Notes: Tamanho=5 Nome=Setor. Descrição=nome do órgão fiscalizador Pesquisar códigos em wsSICOP.ListarOrgaoSetor

private int cdSetorBenef

Notes: Tamanho=5 Nome=Setor Beneficiado. Descrição=informe o setor beneficiado com a obra. Pesquisar códigos em wsSICOP.ListarBeneficiado

private int cdSetorSolict

Notes: Tamanho=5 Nome=Setor Solicitante Descrição=nome da contratante. Pesquisar códigos em wsSICOP.ListarOrgaoSetor

private int cdContratada

Notes: Tamanho=7


17

Nome=Contratada. Descrição=código da contratada. Pesquisar códigos no wsSICOP.ConsultarContratada

private int cdEspTitulo

Notes: Tamanho=3 Nome=Tipo de contrato. Descrição=informe o tipo de contrato. Pesquisar códigos no wsSICOP.ListarTipoTitulo

private string flReajusteServico

Notes: Tamanho=1 Nome=Tipo Reajuste Descrição=informe o tipo de reajuste. Valores= 'S' Por Serviço e 'N' Por Obra

private string flExigeFoto

Notes: Tamanho=1 Nome= Exigir foto para cada grupo de serviço medido. Descrição=informe um dos valores abaixo. Valores= S ou N Opcional

private double vlTitulo

Notes: Tamanho=16 Nome=Valor Obra Descrição=informe o valor do contrato. Mask=99999999999999.99

private int nuDiaCorrido

Notes: Tamanho=4 Nome=Dias do Contrato. Descrição=número de dias do prazo contratual.

private Date dtProposta

Notes: Tamanho=8 Nome= Data da Proposta. Descrição=data da proposta do edital. Mask=YYYY-MM-DD A data do contrato deve ser igual ou posterior a data da proposta.

private Date dtTitulo

Notes: Tamanho=8 Nome= Data do Contrato. Descrição=data da assinatura do contrato. Mask=YYYY-MM-DD A data do contrato deve ser igual ou posterior a data da proposta. A data de início (O.S.) deve ser igual ou posterior a data do contrato.

private string nuOrdemServico

Notes: Tamanho=20 Nome= Número da O.S. Descrição=número da ordem de serviço. Deve ser preenchido caso a situação do título seja igual a Andamento ou Concluído.

private Date dtInicio

Notes: Tamanho=8 Nome=Data de início (O.S.). Descrição=data de início da ordem de serviço. Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Andamento ou Concluído.


18

A data de início (O.S.) deve ser igual ou posterior a data do contrato.

private Date dtFim

Notes: Tamanho=8 Nome=Data de Término. Descrição=data de término do contrato (data de início + dias do contrato). Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Andamento ou Concluído. Seu valor é igual a Data de Inicio acrescido dos dias do contrato.

private Date dtBase

Notes: Tamanho=8 Nome=Data-base. Descrição=data-base do contrato (data da proposta do contrato). Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Andamento ou Concluído.

private Date dtRefReajuste

Notes: Tamanho=8 Nome=Data de referência. Descrição=data de referência (data da ordem de serviço). Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Andamento ou Concluído.

private Date dtEntregaPrevista

Notes: Tamanho=8 Opcional Nome=Data de entrega provisória. Descrição=data do termo de recebimento provisório das obras do contrato. Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Concluído. A data de entrega provisória deve ser menor ou igual a data de término do contrato. A data de entrega provisória deve ser maior ou igual a data de início.

private Date dtEntregaReal

Notes: Tamanho=8

Nome=Data de entrega definitiva. Descrição=data do termo de recebimento definitivo das obras do contrato. Mask=YYYY-MM-DD Deve ser preenchido caso a situação do título seja igual a Concluído. A data de entrega definitiva deve ser maior ou igual a data de entrega provisória. Opcional.

private double vlOriginal

Notes: Tamanho=16 Nome=Valor original. Descrição=valor inicial do contrato. Mask=99999999999999.99 Deve ser preenchido com o valor do campo vlTitulo


19

private string deObservacao

Notes: Tamanho=2000 Nome= Observação. Descrição=alguma informação relevante sobre o contrato. Opcional

Private date dtInauguracao

Data de Inauguração/Previsão

Notes: Tamanho=8 Opcional Nome= Inauguração Descrição= Data de Inauguração/Previsão Mask=YYYY-MM-DD

4.2.2. Objeto XML Edital

Detalhamento dos elementos do objeto XML para o edital do contrato:

Atributos Detalhes

private string nuProcesso

Notes: Tamanho=10 Opcional Nome=Processo. Descrição=código do processo.

Private int nuAnoProcesso

Notes: Tamanho=4 Nome=Ano. Descrição=ano do edital. Mask=YYYY

Private int cdOrgaoSetor

Notes: Tamanho=5 Nome=Solicitante Descrição=sigla e nome do solicitante. Pesquisar código no wsSICOP. ListarOrgaoSetor ()

private string tpEdital

Notes: Tamanho=2 Nome=Modalidade. Descrição=tipo e descrição da modalidade do edital Valores Validos= AD- Aquisição Direta CC- Concorrência CI- Concorrência Internacional CV- Convite DL- Dispensa de Licitação LI- Licitação Pública Internacional PR- Pregão TP- Tomada de Preços

private int nuAnoEdital

Notes: Tamanho=4 Nome=Ano. Descrição=ano do edital. Mask=YYYY

private int nuSeqEdital

Notes: Tamanho=4 Nome=Número.


20

Descrição=número do edital.

Private string flEmpreitada

Notes: Tamanho=1 Nome=Regime de Execução Descrição=selecione o tipo de empreitada. Valor válidos= I-Empreitada Integral

G-Empreitada Preço Global U-Empreitada Preço Unitário

private DATE dtPublicacao

Notes: Tamanho=2 Nome=Data da Publicação. Descrição=data da publicação do edital. Mask=YYYY-MM-DD

private DATE dtBase

Notes: Tamanho=8 Nome=Data-base da proposta vencedora. Descrição=data-base da proposta vencedora do edital. Mask=YYYY-MM-DD Data-base da proposta vencedora deve ser anterior ou igual à Data de abertura.

Private DATE dtAbertura

Notes: Tamanho=8 Nome=Data Abertura. Descrição=data de abertura do edital. Mask=YYYY-MM-DD Data de abertura deve ser anterior ou igual à Data de homologação.

Private DATE

dtHomologacao Notes: Tamanho=8

Nome=Data de homologação. Descrição=data de homologação do edital. Mask=YYYY-MM-DD Data de homologação deve ser anterior ou igual à Data do Contrato.

Private string deObjeto

Notes: Tamanho=250 Nome=Objeto. Descrição=descrição detalhada do objeto do contrato.

Private ouble vlEdital

Notes: Tamanho=14 Nome=Valor do Orçamento Básico. Descrição=valor do orçamento básico do contrato. Mask=999999999999,99

4.2.3. Objeto XML Dotação

Detalhamento dos elementos do objeto XML para a dotação orçamentária do contrato:

Atributo Detalhes

private int NUANO

Notes: Tamanho=4 Nome=Ano. Descrição=ano da dotação orçamentária. Mask=YYYY

private int Notes: Tamanho=8


21

CDELEMENTO Nome=Elemento. Descrição=código do elemento.

Private int CDPROJATIV

Notes: Tamanho=4 Nome= Proj/Ativ Descrição=código do projeto/atividade.

Private int CDFONTE

Notes: Tamanho=4 Nome=Fonte. Descrição=código da fonte de recursos.

Private int CDORGAOSETOR

Notes: Tamanho=5 Nome=Solicitante Descrição=sigla e nome do solicitante. Pesquisar código no wsSICOP.ListarSolicitantes()

4.3. Web service SICOP- Obra

Permite cadastrar obras para um contrato e os profissionais que irão fiscalizá-la, bem como suas respectivas ARTs. Estes objetos serão utilizados pelos métodos IncluirObra, ExcluirObra e ConsultarObra.

4.3.1. Objeto XML Obra

Detalhamento dos elementos do objeto XML para a obra:

Atributos Detalhes


Notes: Ver definições no objeto Contrato. Nome=Contrato Descrição=número do contrato.

Deve ser enviado o nuTitulo do contrato previamente inserido.

Private int cdLote

Notes: Tamanho=2 Nome=Obra. Descrição=número da obra. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a geração do Contrato.

Private string deLote

Notes: Tamanho=100 Nome=Descrição. Descrição=descrição da obra.

Private int

cdTipoObra Notes: Tamanho=2

Nome=Tipo de Obra. Descrição=informe o tipo de obra. Pesquisar códigos no wsSICOP.ListarTipoObra()

private string cdClasse

Notes: Tamanho=3 Nome=Natureza. Descrição=código da natureza da obra. Pesquisar códigos no wsSICOP.ListarNatureza()


22

private ouble qtExtensao

Notes: Tamanho=15 Nome=Dimensão. Descrição=dimensão da obra. Mask=999999999999.999

private string cdUnidMedida

Notes: Tamanho=2

Nome=Unidade de medida. Descrição=informe a unidade de medida referente à dimensão da obra. Pesquisar códigos no wsSICOP.ListarUnidadeMedida()

private string deComplemento

Notes: Tamanho=2000 Nome=Complemento. Descrição=descrição de informação complementar à obra.

Opcional

private ouble peCustoLote

Notes: Tamanho=5 Nome=Custo da obra Descrição=porcentagem do custo da obra. Mask=999.99 Total do percentual dos custos das obras deve ser igual a 100%.

private int cdIndice

Notes: Tamanho=2 Nome= Índice Descrição=código do índice. Pesquisar código no wsSICOP.ListarIndice() Opcional

Somente deve ser preenchido se o campo flReajusteServico do contrato for igual a ‘N’

private string nuBemPuclico

Notes: Tamanho=5 Nome=Bem Público. Descrição=número do bem público.

4.3.2. Objeto XML Fiscal

Detalhamento dos elementos do objeto XML para o fiscal da obra:

Atributos Detalhes

private string nuIdentFiscal

Notes: Tamanho=20 Nome=CPF. Descrição=número do CPF Deve conter um CPF válido.

private string nmFiscal

Notes: Tamanho=50 Nome=Nome. Descrição=nome do fiscal.

private string nuCrea

Notes: Tamanho=10 Nome=Nº CREA. Descrição=número de registro do profissional no CREA.


23

private string sgInidadeFederal

Notes: Tamanho=2 Nome=UF. Descrição=sigla da unidade de federação.

private int cdCargo

Notes: Tamanho=2 Nome=Função.

Descrição=código da função do profissional. Pesquisar código em wsSICOP.ListarCargo()

private int nuPortaria

Notes: Tamanho=20 Nome=Número da Portaria. Descrição=número da portaria da emissão do documento.

private Date dtPortaria

Tamanho = 8 Nome=Data da Portaria. Descrição=Informe a data de emissão do documento.

4.3.3. Objeto XML ART

Detalhamento dos elementos do objeto XML para a ART associada ao fiscal da obra:

Atributos Detalhes

private string nuART

Notes: Tamanho=10 Nome=ART Descrição=número da ART. Unique

private string deART

Notes: Tamanho=50 Nome=Descrição.

Descrição=descrição da ART.

private DATE dtART

Notes: Tamanho=8 Nome=Data. Descrição=data da ART. Mask=YYYY-MM-DD

private string FLPROJETO

Notes: Tamanho=1 Nome=Projeto. Descrição=informe S para ART de projeto. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string

FLEXECUCAO Notes: Tamanho=1

Nome=Execução Descrição= informe S para ART de execução. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLFISCALIZACAO

Notes: Tamanho=1 Nome=Fiscalização Descrição= informe S para ART de fiscalização.


24

Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLMONTAGEM

Notes: Tamanho=1 Nome=Montagem

Descrição= informe S para ART de montagem. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLINSTALACAO

Notes: Tamanho=1 Nome=Instalação. Descrição= informe S para ART de instalação.

Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLREFORMA

Notes: Tamanho=1 Nome=Reforma. Descrição= informe S para ART de reforma. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor

igual a S

private string FLREPARO

Notes: Tamanho=1 Nome=Reparo. Descrição= informe S para ART de reparo. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLSUPERVISAO

Notes: Tamanho=1 Nome=Supervisão. Descrição= informe S para ART de supervisão. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLORCAMENTO

Notes: Tamanho=1 Nome=Orçamento. Descrição= informe S para ART de orçamento. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLCONSULTORIA

Notes: Tamanho=1 Nome=Consultoria. Descrição= informe S para ART de consultoria. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string FLESPECIFICACAO

Notes: Tamanho=1 Nome=Especificação. Descrição= informe S para ART de especificação. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S


25

private string FLOUTROS

Notes: Tamanho=1 Nome=Outros Descrição= informe S para ART de outros. Valores S ou N Grupo Tipo de Atividade, pelo menos um deve ter valor igual a S

private string DEOBSERVACAO

Notes: Tamanho=2000 Nome=Observação. Descrição=alguma informação relevante. Opcional

private string FLCOMPLEMENTAR

Notes: Tamanho=1

Nome=ART Complementar. Descrição= informe S para ART complementar (Refere-se a um aditivo). Valores S ou N

private DATE DTINICIO

Notes: Tamanho=8 Nome=Data Início. Descrição=data de início da ART. Mask=YYYY-MM-DD

O campo Data Início não pode ser posterior ao campo Data Término.

private DATE DTFIM

Notes: Tamanho=8 Nome=Data término. Descrição= data de término da ART. Mask=YYYY-MM-DD O campo Data Início não pode ser posterior ao campo Data Término.

private integer nuArtOriginal

Notes: Tamanho=10 Nome=ART Original Descrição=número da ARTOriginal quando esta for complementar. Opcional

4.3.4. Objeto XML MunicipioObra

Detalhamento dos elementos do objeto XML para os Municípios da Obra:

Atributos Detalhes

private int cdMunicipio

Notes: Tamanho=5 Nome=Município. Descrição=código do município. Pesquisar código no wsSICOP.ListarMunicipios()

private int qtExtensao

Notes: Tamanho=15 Nome=Dimensão. Descrição=dimensão da obra no município. Mask=999999999999,999


26

A soma das "Dimensões" deve ser igual a "Dimensão da obra" .

private int peCustoLote

Notes: Tamanho=5 Nome=Custo %. Descrição=porcentagem do custo da obra para o

município. Mask=999,99 A soma do "Custo %" deve ser igual a 100,00.

4.4. Web service SICOP- TituloFoto

Permite o envio de imagens digitalizadas das obras dos contratos. Os objetos abaixo serão utilizados pelos métodos IncluirTituloFoto, ExcluirTituloFoto e ConsultarTituloFoto.

4.4.1. Objeto XML TituloFoto

Detalhamento dos elementos do objeto XML para a Foto do Título:

Atributos Detalhes


Notes: Ver detalhes no Contrato. Nome=Contrato. Descrição=número do contrato. Pesquisar código no wsSICOP.ConsultarContrato()

private int nuFoto

Notes: Tamanho=3 Nome=Número da Foto. Descrição=número de identificação da foto. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a inclusão do Contrato e do Lote.

private date dtFoto

Notes: Tamanho=8 Nome=Data da Foto. Descrição=data em que a foto foi tirada. Mask=YYYY-MM-DD

private int cdLote

Notes: Var detalhes na Obra. Nome=Obra Descrição=número da obra. Pesquisar código no wsSICOP.ConsultarObra().

private int cdGrupoServico

Notes: Tamanho=4 Nome= Grupo de Serviço. Descrição=código do Grupo de Serviço. Pesquisar código no wsSICOP.ListarGrupoServicoLote()

private int tpFotoObra

Notes: Tamanho=3 Nome=Tipo de Foto. Descrição=código do tipo de foto das obras. Pesquisar código no wsSICOP.ListarTipoFoto() Opcional


27

private string deFoto

Notes: Tamanho=50 Nome=Descrição da Foto Descrição=descrição da foto. Opcional

private string nmResponsavel

Notes: Tamanho=50

Nome=Fotografado por. Descrição=nome do responsável que fotografou a obra. Opcional

private string imFoto

Notes: Tamanho= 1000000 Nome=Arquivo da imagem. Descrição=imagem representada em base64.



4.5. Web service SICOP- Serviço

Possibilita o cadastro da planilha de serviços do contrato, que são as atividades que serão executadas e medidas no decorrer do prazo de execução do contrato. Os objetos listados abaixo serão utilizados pelos métodos IncluirServico, ExcluirServico e ConsultarServico.

4.5.1. Objeto XML ServicoContratoObra

Detalhamento dos elementos do objeto XML para os Serviços da Obra do Contrato:

Atributos Detalhes


Notes: Ver detalhes no Contrato. Nome=Contrato. Descrição=número do contrato. Pesquisar código em wsSICOP.ConsultarContrato()

private int cdLote

Notes: Ver detalhes na Obra. Nome=Obra. Descrição=código da obra. Pesquisar código em wsSICOP.ConsultarObra()


Notes: Tamanho=4 Nome= Grupo de Serviço. Descrição=código do grupo de serviços. Pesquisar código no wsSICOP.ListarGrupoServico()

private int cdServContrato

Notes: Tamanho=4 Nome= Serviço. Descrição=código do serviço. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a geração do Contrato e do Lote.


28

private int nuOrdem

Notes: Tamanho=5 Nome=Ordem

Descrição=Permite indicar qual ordem irão aparecer os serviços

private string

cdServAuxiliar

Tamanho=20

Nome=Código do Serviço Descrição=informe o código próprio do serviço.

private string deServContrato

Notes: Tamanho=1000 Nome= Descrição do Serviço Descrição=informe a descrição do Serviço.


Notes: Tamanho=6 Nome= Unidade de Medida Descrição=código da unidade de medida. Pesquisar código no wsSICOP.ListarUnidadeMedida()

private double qtContratada

Notes: Tamanho=14 Nome= Quantidade Contratada

Descrição=valor da quantidade contratada .Mask=99999999999,999

private double vlCoafC

Notes: Tamanho=16 Nome= Valor Material Descrição=valor do material. Mask=999999999999,9999

private double vlCoefD

Notes: Tamanho=16 Nome= Valor Mão-de-Obra Descrição=valor da mão-de-obra. Mask=999999999999,9999

private int cdIndice

Notes: Tamanho=2 Nome= Índice Descrição=código do índice. Pesquisar código no wsSICOP.ListarIndice() Opcional

Preencher este campo somente se o campo flReajusteServico do contrato for igual a ‘S’

4.6. Web service SICOP- Aditivo

Possibilita o cadastro de aditivos do contrato, que podem ser de prazo ou de quantidades. Os objetos listados abaixo serão utilizados pelos métodos IncluirAditivo, ExcluirAditivo e ConsultarAditivo.

4.6.1. Objeto XML Aditivo

Detalhamento dos elementos do objeto XML para o Aditivo:


29

Attribute Details



private int nuAditivo

Notes: Tamanho=2 Nome=Aditivo. Descrição=número do aditivo do contrato. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a geração do Contrato.

private date dtAditivo

Notes: Tamanho=8 Nome= Data do Aditivo Descrição=data de início do aditivo do contrato. Masc=YYYY-MM-DD

private string deTermoAditivo

Notes: Tamanho=20 Nome= Termo do aditivo nº Descrição=número do termo aditivo do contrato. Opcional

private int nuDiaCorrido

Notes: Tamanho=4 Nome= Dias prorrogados Descrição=número de dias do contrato prorrogados.

private double vlAditivo

Notes: Tamanho=14 Nome= Valor Aditivo Descrição=informe o valor do aditivo do contrato. Mask=999999999999,99


Notes: Tamanho=500 Nome= Justificativa

Descrição=alguma informação relevante.

4.7. Web service SICOP- ServicoAditivo

Possibilita o cadastro dos serviços do aditivo. Os objetos listados abaixo serão utilizados pelos métodos IncluirServicoAditivo, ExcluirServicoAditivo e ConsultarServicoAditivo.

4.7.1. Objeto XML ServicoAditivo

Detalhamento dos elementos do objeto XML para o ServiçoAditivo:

Attribute Details




30

private int nuAditivo

Notes: Tamanho=2 Nome=Aditivo. Pesquisar código em wsSICOP.consultarAditivo();

private int cdLote

Notes: Ver detalhes na Obra. Nome=Obra.

Descrição=código da obra. Pesquisar código em wsSICOP.ConsultarObra()


Notes: Tamanho=4 Nome= Grupo de Serviço. Descrição=código do grupo de serviços. Pesquisar código no wsSICOP.consultarServico()

private int cdServContrato

Notes: Tamanho=5 Nome= Serviço. Descrição=código do serviço. Para incluir um novo serviço não deve ser informado. No entanto, para atualizar os dados de um serviço existente é necessário informá-lo. Opcional

private double qtAAditar

Notes: Tamanho=14 Nome= Qtde a aditar Descrição=informe a quantidade a aditar. Mask=999999999999,999

private double vlCoefC

Notes: Tamanho=16 Nome= Valor Material Descrição=valor do material. Mask=999999999999,9999 Opcional - somente necessário se for um serviço novo.

private double vlCoefD

Notes: Tamanho=16 Nome= Valor Mão-de-Obra Descrição=valor da mão-de-obra. Mask=999999999999,9999 Opcional - somente necessário se for um serviço novo.


Notes: Tamanho=6 Nome= Unidade de Medida Descrição=código da unidade de medida. Pesquisar código no wsSICOP.ListarUnidadeMedida() Opcional - somente necessário se for um serviço novo.

private string cdServAuxiliar

Tamanho=20 Nome=Código do Serviço Descrição=informe o código próprio do serviço. Opcional - somente necessário se for um serviço novo.

private string deServContrato

Notes: Tamanho=1000 Nome= Descrição do Serviço

Descrição=informe a descrição do Serviço. Opcional - somente necessário se for um serviço novo.


31

4.8. Web service SICOP- Paralisação

Possibilita cadastrar os períodos de paralisação dos serviços do contrato, por conveniência ou não das partes contratantes. Os objetos listados abaixo serão utilizados pelos métodos IncluirParalisação, ExcluirParalisação e ConsultarParalisação.

4.8.1. Objeto XML Paralisação

Detalhamento dos elementos do objeto XML para a Paralisação:

Atributos Detalhes

private int NUTITULO

Notes: Ver detalhes no Contrato. Nome=Contrato. Descrição=número do contrato. Pesquisar código no wsSICOP.ConsultaContrato().

private int CDPARALISACAO

Notes: Tamanho=2 Nome= Paralisação. Descrição=código da paralisação. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a geração do Contrato.

private DATE DTPARALISACAO

Notes: Tamanho=8 Nome= Data da Paralisação Descrição=data da paralisação do contrato. Mask=YYYY-MM-DD A data da paralisação deve ser menor ou igual a data de término do contrato. A data da paralisação deve ser menor que a data de reinício.

private string DETERMOPARALISACAO

Notes: Tamanho=20 Nome= Termo da Paralisação Descrição=descrição do termo da paralisação. Opcional

private DATE DTTERMOPARALISACAO

Notes: Tamanho=8 Nome= Data do termo da paralisação. Descrição=data do termo da paralisação. Mask=YYYY-MM-DD

private DATE DTREINICIO

Notes: Tamanho=8 Nome= Data de reinício Descrição=data de reinício do contrato.

Mask=YYYY-MM-DD Opcional

private string DETERMOREINICIO

Notes: Tamanho=20 Nome= Termo de Reinício Descrição=descrição do termo de reinício do contrato. Opcional


32

private DATE DTTERMOREINICIO

Notes: Tamanho=8 Nome= Data do termo de reinício. Descrição=data do termo de reinício. Mask=YYYY-MM-DD Opcional

private double PEEXECFISICA

Notes: Tamanho=7 Nome= Percentual exec. Físico Descrição=número do percentual de execução físico. Mask=999.9999 Opcional


Notes: Tamanho=250 Nome= Justificativa

Descrição=descrição da justificativa.

private integer cdMotivoOcorrencia

Notes: Ver detalhes no Motivo Paralisação Nome=Motivo. Descrição=Código motivo paralisação. Pesquisar código no wsSICOP.ListarMotivoParalisacao().

4.9. Web service SICOP- ParalisacaoFoto

Permite o envio de imagens digitalizadas das obras paralisadas. Os objetos abaixo serão utilizados pelos métodos IncluirParalisacaoFoto, ExcluirParalisacaoFoto e ConsultarParalisacaoFoto.

4.9.1. Objeto XML ParalisacaoFoto

Detalhamento dos elementos do objeto XML para a foto da paralisação:

Atributos Detalhes

private Integer nuTitulo


private Integer cdParalisacao

Notes: Tamanho=3 Nome=Identificador da paralisação. Pesquisar código em wsSICOP.consultarParalisacao().

private int nuFoto

Notes: Tamanho=3 Nome=Número da Foto. Descrição=número de identificação da foto. Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Só pode ser gerado após a inclusão da paralisação.

private date dtFoto

Notes: Tamanho=8 Nome=Data da Foto. Descrição=data em que a foto foi tirada. Mask=YYYY-MM-DD


33

private int cdLote

Notes: Var detalhes na Obra. Nome=Obra Descrição=número da obra. Pesquisar código no wsSICOP.ConsultarObra().


Notes: Tamanho=4

Nome= Grupo de Serviço. Descrição=código do Grupo de Serviço. Pesquisar código no wsSICOP.ListarGrupoServicoLote()


Notes: Tamanho=3 Nome=Tipo de Foto. Descrição=código do tipo de foto das obras. Pesquisar código no wsSICOP.ListarTipoFoto()

Opcional

private string deFoto

Notes: Tamanho=50 Nome=Descrição da Foto Descrição=descrição da foto. Opcional

private string nmResponsavel

Notes: Tamanho=50 Nome=Fotografado por. Descrição=nome do responsável que fotografou a obra. Opcional

private string imFoto

Notes: Tamanho= 1000000 Nome=Arquivo da imagem. Descrição=imagem representada em base64.



4.10. Web service SICOP- Rescisão

Possibilita rescindir um contrato cadastrado. Os objetos listados abaixo serão utilizados pelos métodos IncluirRescisão, ExcluirRescisão e ConsultarRescisão.

4.10.1. Objeto XML Rescisão

Detalhamento dos elementos do objeto XML para a Rescisão:

Atributos Detalhes

private int NUTITULO

Notes: Ver detalhes no Contrato. Nome=Contrato. Descrição=número do contrato. Pesquisar código no wsSICOP.ConsultarContrato().

private DATE DTRESCISAO

Notes: Tamanho=8 Nome= Data Descrição=data da rescisão do contrato.


34

Masc=YYYY-MM-DD

private string DETERMORESCISAO

Notes: Tamanho=20 Nome= Termo da Rescisão Descrição=descrição do termo da rescisão Opcional


Notes: Tamanho=250 Nome= Justificativa Descrição=descrição da justificativa.

private String

cdFormaRescisao Notes: Tamanho=1

Nome=Forma de rescisão Descrição= Forma de rescisão Pesquisar código no wsSICOP.ListarFormaRescisao().

4.10.2. Objeto XML MotivoRescisao

Detalhamento dos elementos do objeto XML para os Motivos da Rescisão vinculados ao contrato:

Attribute Details

private Integer cdMotivoOcorrencia

Notes: Ver detalhes no MotivoOcorrencia Nome=Motivo. Descrição=Código motivo rescisao. Pesquisar código no wsSICOP.ListarMotivoRescisao().

4.11. Web service SICOP- Medição

Cadastrar o cabeçalho da medição de um contrato e os percentuais executados acumulados da medição por grupo de serviço ou por serviço. Também é possível consultar os profissionais que compõem a comissão de fiscalização das obras cadastradas. Os objetos listados abaixo serão utilizados pelos métodos IncluirMedicao, ExcluirMedicao e ConsultarMedicao.

4.11.1. Objeto XML Medição

Detalhamento dos elementos do objeto XML para a Medição:

Attribute Details


Notes: Ver detalhes no Contrato. Nome=Contrato Descrição=número do contrato. Pesquisar no wsSICOP.ConsultarContrato().

private Integer nuMedicao

Notes: Identificador único do objeto, é definido na


35

inclusão do mesmo. Pode ser utilizada para consulta do objeto. Nome=Medição. Descrição=número da medição.

private String deMedicao

Notes: Tamanho=70 Nome= Descrição Descrição=descrição da medição.

private DATE dtMedicao

Notes: Tamanho=8 Nome= Data da Medição Descrição=data da medição do contrato. Mask=YYYY-MM-DD A data de medição deve estar dentro da data inicial e final do contrato A data de medição deve ser maior ou igual a data de término

private DATE dtIniMedicao

Notes: Tamanho=8 Nome= Data início Descrição=data de início da medição. Mask=YYYY-MM-DD A data de início deve estar dentro da data inicial e final do contrato

private DATE dtFimMedico

Notes: Tamanho=8 Nome= Data término Descrição=data de término da medição. Mask=YYYY-MM-DD A data de término deve estar dentro da data inicial e final do contrato A data de término deve ser posterior a data inical da medição.

private double peExecFisica

Notes: Tamanho=7 Nome= Percentual físico executado Descrição=número percentual físico executado. Mask=999.99

private String deObservacao

Notes: Tamanho=250 Nome= Observação Descrição=alguma informação relevante. Opcional

private String flFinal

Notes: Tamanho=1 Nome= Tipo de medição

Descrição=informe o tipo de medição. Valores='F' para Final ou 'N' Parcial

private String flImplantacao

Notes: Tamanho=1 Nome= Implantação Descrição=indica se a medição é de implantação Valores='S' ou 'N'

private Integer qtMinFiscal

Notes: Tam=1 Desc=Quantidade Mínima de Físcais A quantidade de fiscais enviados de ser igual ao campo qtMinFiscais


36

private String flCronograma

Notes: Tamanho=1 Nome=Cronograma Descrição=Indica situação do cronograma Valores= 1-Cronograma em Dia, 2-Cronograma Atrasado e 3-Cronograma Adiantado

private String flRitmoLento

Notes: Tamanho=1 Nome=Ritmo lento Descrição=Indica se é ritmo lento. Valores= 0-Não 1-Sim

private Integer cdMotivoOcorrencia

Notes: Tamanho=2 Nome=Motivo Atraso Descrição=código do Motivo do Atraso Pesquisar código em wsSICOP.ListarMotivoAtraso() Opcional se flCronograma <> 2

4.11.2. Objeto XML Comissão de Fiscalização (FISCAL)

Detalhamento dos elementos do objeto XML para a Comissão de Fiscalização:

Atributos Detalhes




Notes: Identificador único do objeto é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto.

Nome=Medição. Descrição=número da medição.

private Integer cdLote

Notes: Tamanho=4 Nome= Obra Descrição=indentificador da obra Pesquisar código no wsSICOP.consultarObra().

private String nuIdentFiscal

Notes: Tamanho=20 Nome= CPF Descrição=número do CPF. Deve conter um CPF válido.

private int cdCargo

Notes: Tamanho=2 Nome=Cargo Descrição=função exercida pelo profissional. Pesquisar código em wsSICOP.ListarCargo()

4.11.3. Objeto XML QuantidadeMedição

Detalhamento dos elementos do objeto XML para a quantidade executada da medição:


37

Atributos Detalhes

private int CDLOTE

Notes: Ver detalhes no objeto Obra. Nome=Obra Descrição=código da obra. Pesquisar código no wsSICOP.ConsultarObra()

private int CDGRUPOSERVICO

Notes: Ver detalhes no objeto GrupoServico. Nome=Grupo de Serviço Descrição= código do grupo de serviço. Pesquisar código no wsSICOP.consultarServico(Lote)

private int CDSERVCONTRATO

Notes: Ver detalhes no objeto ServicoContratoLote. Nome=Serviço Descrição=código do serviço Pesquisar código no wdSICOP.ConsultarServico(nuTitulo,cdLote,nuMedicao,cdGrupoServico)

private Double QTACUMATUAL

Notes: Tamanho=16 Nome= Qt. Acumulada Descrição=informe a quantidade acumulada. Mask=9999999999999,999 O campo "Qt.Acumulada" deve ser preenchido. A quantidade acumulada deve ser menor ou igual a quantidade contratada.

private Double PEEXECUTADO

Notes: Tamanho=6 Nome=% Exec Descrição=informe a porcentagem executada acumulada. Mask=9999,99 O campo "% Exec." deve ser preenchido. O campo "% Exec." deve ser menor ou igual a 100,000.

private Double vlAtual

Notes: Tamanho=16 Nome=% Exec Descrição=informe a porcentagem executada acumulada. Mask=99999999999999,99 O campo “vlAtual” deve ser preenchido caso a medição seja de implantação.

4.11.4. Objeto XML MedicaoGrupo

Detalhamento dos elementos do objeto XML para os grupos da medição:

Atributos Detalhes

private int CDLOTE

Notes: Ver detalhes na Obra Pesquisar código no wsSICOP.ConsultarObra(). Nome=Obra Descrição=código da obra.

private NUMBER CDGRUPOSERVICO

Notes: Ver detalhes no GrupoServico. Pesquisar código no wsSICOP.consultarServico(). Nome=Grupo de Serviço Descrição=código do grupo de serviço.

private double Notes: Tamanho=6


38

PEEXECUTADO Nome= Percentual Executado Descrição=informe o percentual executado Mask=9999,99

4.12. Web service SICOP- Bem Público

4.12.1. Objeto XML BemPublico

Detalhamento dos elementos do objeto XML para os bens públicos:

Atributos Detalhes

private Integer nuBemPublico

Notes: Tamanho=5 Nome=Código Descrição=Código identificador do Bem Público. Identificador único do objeto definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto.

private string deBemPublico

Notes: Tamanho=255 Nome=Descrição Descrição=Descrição do Bem Público

private Integer cdMunicipio

Notes: Tamanho=5 Nome=Município Descrição=Código do município. Pesquisar dados no wsSICOP.ConsultarMunicipio

private string deLogradouro

Notes: Tamanho=255 Nome=Rua/Av Descrição=Endereço do Bem Público Opcional

private string deBairro

Notes: Tamanho=50 Nome=Bairro Descrição=Nome do bairro localizado o Bem Público Opcional

private string deComplemento

Notes: Tamanho=50 Nome=Complemento Descrição=Informações complementares da localização do Bem Público Opcional

private int nuLogradouro

Notes: Tamanho=10 Nome=Número Descrição=Número do logradouro. Opcional


39

private int nuCep

Notes: Tamanho=8 Nome=CEP Descrição=Código do Endereçamento Postal Opcional

private string tpPatrimonio

Notes: Tamanho=1 Nome=Tipo Patrimônio Descrição=Informe o código correspondente ao tipo de patrimônio, os código pode ser: 1-Patrimônial, 2-Uso Comum ou 3-Terceiros

4.12.2. Objeto XML RegistroImovel

Detalhamento dos elementos do objeto XML para registro do imóvel vinculado aos bens públicos:

Attribute Details

private Integer nuSegregistro

Notes: Tamanho=2 Nome=Código Descrição= Identificador único do objeto definido na inclusão do mesmo.

private Integer

cdCartorio Notes: Tamanho=4

Nome=Código Descrição=Código do Cartório Buscar código no wsSicop.ListarCartorio()

private String nuRegistro

Notes: Tamanho=255 Nome=Registro Descrição=Número do Registro no Cartório

4.13. Web service SICOP - Recebimento Provisório

4.13.1. Objeto XML RecebimentoProvisorio

Detalhamento dos elementos do objeto XML para ocorrência do recebimento provisório do contrato:

Attribute Details



private date dtRecebimento

Notes: Tamanho=8 Nome=Data Recebimento. Descrição=Data Recebimento Provisório. Mask=YYYY-MM-DD


40

private doble vlPendente

Notes: Tamanho=16 Nome=Valor pagamento final pendente. Descrição=Valor pagamento final pendente. Mask=99999999999999.99


Notes: Tamanho=250 Nome= Observação. Opcional

private int cdFiscalContratante

Notes: Tamanho=4 Nome=Fiscal da Contratante Descrição=código do fiscal da contratante.

private String nuPortaria

Notes: Tamanho=20 Nome= Número da portaria. Descrição=Número da portaria do fiscal da contratante.

private date dtPortaria

Notes: Tamanho=8 Nome= Data da portaria. Descrição=Data da portaria do fiscal da contratante. Mask=YYYY-MM-DD

private int cdFiscalContratado

Notes: Tamanho=4 Nome=Fiscal da contratada Descrição=código do fiscal da contratada. Opcional

4.14. Web service SICOP- Recebimento Definitivo

4.14.1. Objeto XML RecebimentoDefinitivo

Detalhamento dos elementos do objeto XML para ocorrência do recebimento definitivo do contrato:

Attribute Details



private date dtRecebimento

Notes: Tamanho=8 Nome= Data recebimento definitivo. Descrição=data do recebimento definitivol. Mask=YYYY-MM-DD Data do Habiti-se deve ser maior que data recebimento definitivo

private date dtPagtoMedFinal

Notes: Tamanho=8 Nome= Data pagamento final. Descrição=Data pagamento final realizado. Mask=YYYY-MM-DD

Private String flProjetoRevisado

Notes: Tamanho=1 Nome=Projeto Revisado.


41

Descrição="As built" - Projeto final Revisado Valores=1-Arquivado UG ou 2-Não Realizada a revisão.

private String flHabitise

Notes: Tamanho=1 Nome=Habitise. Descrição=Foi realizada emissão do Habitise Valores=1-Habitise Obtido ou 2-Não Obtido.

private date dtHabitise

Notes: Tamanho=8 Nome= Data Emissão Habitise. Descrição=Data Emissão Habitise Mask=YYYY-MM-DD

private String flProgManutencao

Notes: Tamanho=1 Nome=Bem Incluido no Programa de Manutenção. Descrição=Bem Incluido no Programa de Manutenção Valores=1-Sim, 2-Não ou 3-Não existe programa.

private int cdFiscalContratante

Notes: Tamanho=4 Nome=Fiscal da Contratante Descrição=código do fiscal da contratante.

private String nuPortaria

Notes: Tamanho=20 Nome= Número da portaria. Descrição=Número da portaria do fiscal da contratante.

private date dtPortaria

Notes: Tamanho=8 Nome= Data da portaria. Descrição=Data da portaria do fiscal da contratante. Mask=YYYY-MM-DD

private int cdFiscalContratado

Notes: Tamanho=4 Nome=Fiscal da contratada Descrição=código do fiscal da contratada. Opcional


Notes: Tamanho=250 Nome= Observação. Opcional

4.15. Web service SICOP – Pagamento

Possibilita cadastrar os pagamentos e reajustes pagos. Os objetos listados abaixo serão utilizados pelos métodos IncluirPagamento, EstornarPagamento e ConsultarPagamento.

4.15.1. Objeto XML Empenho

Detalhamento dos elementos do objeto XML para o empenho:

Atributos Detalhes

private Integer Notes: Ver detalhes no Contrato.


42

nuTitulo Nome=Contrato Descrição=número do contrato. Pesquisar no wsSICOP.ConsultarContrato().

Deve ser um contrato existente, ou seja, já estar cadastrado.

private string nuempenho

Notes: Tamanho =17 Nome=Empenho Descrição=número do empenho. Mask= AAAANL99999999999 ou AAAANE99999999999 Se for inclusão o sistema verifica se o empenho já existe e não deixa inserir novamente.

Private integer tpempenho

Notes: Tamanho = 4 Nome=Tipo Descrição=Tipo de empenho Valores = 1 – empenho

Private date dtmovimentacao

Notes: Tamanho = 8 Nome=Data da movimentação. Descrição=Informe a data movimentação. Mask=YYYY-MM-DD

Private double vlmovimentacao

Notes: Tamanho=14 Nome= Valor movimentação Descrição=valor da movimentação Mask=99999999999999,99

4.15.2. Objeto XML Liquidação

Detalhamento dos elementos do objeto XML para a liquidação:

Atributos Detalhes




Private integer numedicao

Notes: Tamanho = 3 Nome=Medição Descrição=número da medição. Pesquisar no wsSICOP.ConsultarMedicao().


Notes: Tamanho = 17 Nome=Empenho Descrição=número do empenho. Mask= AAAANL99999999999 ou AAAANL99999999999 Se for inclusão o sistema verifica se a


43

liquidação já existe e não deixa inserir novamente.

Private integer tpempenho

Notes: Tamanho = 4 Nome=Tipo

Descrição=Tipo de liquidação Valores = 5 – liquidação

private string nuempenhopai

Notes: Ver detalhes no empenho. Nome=Empenho pai Descrição=Indica a que empenho a liquidação pertence. Pesquisar no WsSICOP.ConsultarEmpenho Se for inclusão o sistema verifica se o empenho existe, caso não exista o sistema não deixa incluir a liquidação.

Private date dtmovimentacao

Notes: Tamanho = 8 Nome=Data da movimentação. Descrição=Informe a data movimentação. Mask=YYYY-MM-DD

Private double vlmovimentacao

Notes: Tamanho=14 Nome= Valor movimentação Descrição=valor da movimentação Mask=99999999999999,99 Não permite inserir valor superior ao valor do empenho.

4.15.3. Objeto XML Pagamento

Detalhamento dos elementos do objeto XML do pagamento da medição e reajuste:

Atributos Detalhes


Notes: Ver detalhes na liquidação. Nome=Empenho. Descrição=número do empenho. Pesquisar código em wsSICOP.ConsultarLiquidacao()


Notes: Ver detalhes no Contrato. Nome=Contrato. Descrição=número do contrato. Pesquisar código em wsSICOP.ConsultarContrato()


Private string nupagamento

Notes: Tamanho = 15 Nome=Pagamento. Descrição=Informe o número do pagamento Não permite inclusão se já existir o pagamento

Private string nudocumento

Notes: Tamanho = 20 Nome=Documento. Descrição=Informe o número do documento Mask = AAAAPP99999999999999 Opcional


44

Private date dtpagamento

Notes: Tamanho = 8 Nome= Data pagamento. Descrição=Informe a data do pagamento Mask=YYYY-MM-DD

Private integer vlpagamento

Notes: Tamanho = 14 Nome= Valor pagamento Descrição=Informe o valor do pagamento Mask = 99999999999999,99 Não permite salvar pagamento se o total pago for superior ao valor da liquidação.

4.15.4. Objeto XML Estorno

Detalhamento dos elementos do objeto XML do estorno do empenho ou liquidação:

Atributos Detalhes

private string nuestorno

Notes: Tamanho=19

Nome=Número Descrição= Indica o número do estorno. Se o estorno já existir o sistema não deixa enviar novamente

private int nutitulo

Notes:

Ver detalhes no Contrato. Nome=Contrato Descrição=número do contrato. Pesquisar no wsSICOP.ConsultarContrato().


Private string nuempenho

Notes: Ver detalhes no empenho. Nome=Empenho pai Descrição=Indica a que empenho a liquidação pertence. Pesquisar no WsSICOP.ConsultarEmpenho ou Pesquisar no WsSICOP.ConsultarLiquidacao Deve ser um empenho ou liquidação existente, ou seja, já estar cadastrado. Não permite cadastrar estorno se liquidação se já existir pagamento. Não permite cadastrar estorno de empenho se já existir liquidação.

Private date dtestorno

Notes: Tamanho = 8 Nome=Data

Descrição = Data do estorno Mask = YYYY-MM-DD

Private integer vlestorno

Notes: Tamanho = 14 Nome = Valor Descrição = Indica o valor do estorno Não permite salvar um estorno com valor zero ou maior


45

que o valor do empenho ou liquidação. Não permite salvar estorno com valor superior ao e empenho ou liquidação. Não permite salvar um estorno de empenho maior do que o valor liquidado. Não permite salvar um estorno de liquidação maior que o valor pago.

Private string decausa

Notes: Tamanho =2000 Nome=Causa Descrição = Indica a descrição do porque foi realizado o estorno.

4.15.5. Objeto XML EstornoPagamento

Detalhamento dos elementos do objeto XML do estorno do pagamento:

Atributos Detalhes


Notes: Ver detalhes na liquidação. Nome=Empenho. Descrição=número do empenho. Pesquisar código em wsSICOP.ConsultarLiquidacao() Deve ser uma liquidação existente, ou seja, já estar cadastrada.

Private string nupagamento

Notes: Ver detalhes no pagamento Nome= Número do pagamento Descrição = Número do pagamento Pesquisar número em WsSICOP.ConsultarPagamento()

private int nutitulo

Notes:

Ver detalhes no Contrato. Nome=Contrato Descrição=número do contrato. Pesquisar no wsSICOP.ConsultarContrato().


private string nuestorno

Notes: Tamanho=15 Nome=Número do estorno Descrição=Indica o número identificador do estorno Não deixa incluir estorno de pagamento se já existir.

private string dtestorno

Notes:Tamanho=8 Nome= Data Descrição= Indica a data do estorno

private int vlestorno

Notes:Tamanho=14 Nome= Valor Descrição=Indica o valor do estorno Não permite salvar um estorno com valor zero ou maior que o valor do pagamento


46

4.16. Web servisse SICOP – Reajuste

Possibilita cadastrar os reajustes. Os objetos listados abaixo serão utilizados pelos métodos IncluirReajuste e ConsultarReajuste.

4.16.1. Objeto XML ReajusteMedicao

Detalhamento dos elementos do objeto XML para ocorrência do reajuste da medição do contrato:

Attribute Details

private Integer

nuTitulo Notes: Ver detalhes no Contrato.

Nome=Contrato Descrição=número do contrato. Pesquisar no wsSICOP.ConsultarContrato().


Notes: Ver detalhes na Medição Identificador único do objeto, é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Nome=Medição. Descrição=número da medição. Pesquisar no wsSICOP.ConsultarMedicao().

private DATE dtMedicao

Notes: Tamanho=8 Nome= Data da Medição

Descrição=data da medição do contrato. Mask=YYYY-MM-DD A data de medição deve estar dentro da data inicial e final do contrato A data de medição deve ser maior ou igual a data de término

private DATE dtIniMedicao

Notes: Tamanho=8 Nome= Data início Descrição=data de início da medição. Mask=YYYY-MM-DD A data de início deve estar dentro da data inicial e final do contrato

private DATE dtFimMedicao

Notes: Tamanho=8 Nome= Data término Descrição=data de término da medição. Mask=YYYY-MM-DD A data de término deve estar dentro da data inicial e final do contrato A data de término deve ser posterior a data inical da medição.

Private Double vlreajuste

Notes: Tamanho=14 Nome= Reajuste Descrição=valor do reajuste Mask=99999999999999,99


47

Private string flreajuste

Notes: Tamanho=1 Nome= tipo de reajuste Descrição=indica o tipo do reajuste da medição informar D = Definitivo

Private String tpreajuste

Notes: Tamanho=1 Nome= Opção do reajuste Descrição=Opção do reajuste de valores da medição informar I = Informado

4.16.2. Objeto XML ReajusteMedicaoObra

Detalhamento dos elementos do objeto XML para o reajuste da medição da obra:

Atributos Detalhes



private Integer cdlote

Notes: Ver detalhes no objeto Obra. Nome=Obra Descrição=código da obra. Pesquisar código no wsSICOP.ConsultarObra()

private Integer numedicao

Notes: Ver detalhes na Medição Identificador único do objeto é definido na inclusão do mesmo. Pode ser utilizada para consulta do objeto. Nome=Medição. Descrição=número da medição. Pesquisar no wsSICOP.ConsultarMedicao().

Private Double vlreajuste

Notes: Tamanho=14 Nome= Reajuste

Descrição=valor do reajuste Mask=99999999999999,99 O valor total dos reajustes da obra deve ser igual ao valor informado no reajuste da medição.

4.17. Web service SICOP- Listas

Relação de objetos XML que permitem somente a consulta por meio do método listar de cada objeto.

4.17.1. Objeto XML Cargo


48

Consultar os cargos correspondentes de cada profissional. Detalhamento dos elementos do objeto XML para a consulta do cargo por meio do método wsSICOP.ListarCargo():

Atributos Detalhes

private int cdCargo

Notes: Tamanho=2

Nome=Cargo Descrição=código do cargo.

private string deCargo

Notes: Tamanho=50

Nome=Descrição Descrição=descrição do cargo.

private string deCargoResumido

Notes: Tamanho=20

Nome=Cargo Resumido Descrição=nome do cargo resumido.

4.17.2. Objeto XML GrupoServico

Consultar os grupos de serviços. Detalhamento dos elementos do objeto XML para a consulta dos grupos de serviços por meio dos métodos wsSICOP.ListarGrupoServico() e wsSICOP.ListarGrupoServicoLote(), este último filtra somente os serviços vinculados a uma determinada obra passada como parâmetro para o método:

Atributos Detalhes

private int

cdGrupoServico Notes: Tamanho=4

Nome= Grupo de Serviço Descrição=código do grupo de serviço.

private string deGrupoServico

Notes: Tamanho=50 Nome= Descrição Descrição=descrição do grupo de serviço.

4.17.3. Objeto XML Indice

Consultar os índices de reajuste. Detalhamento dos elementos do objeto XML para o índice de valores, que pode ser obtido por meio do método wsSICOP.ListarIndice():

Atributos Detalhes

private int CDINDICE

Notes: Tamanho=2 Nome=Índice Descrição=código do índice.

private string DEINDICE

Notes: Tamanho=50

Nome=Descrição Descrição=descrição do índice.

private string SGINDICE

Notes: Tamanho=6

Nome=Sigla Descrição=sigla do índice.


49

4.17.4. Objeto XML Município

Consultar os municípios. Detalhamento dos elementos do objeto XML para os municípios, que pode ser obtido por meio do método wsSICOP.ListarMunicipio():

Atributos Detalhes

private int cdMunicipio

Notes: Tamanho=5

Nome=Código Descrição=código do município.

private string nmMunicipio

Notes: Tamanho=50

Nome=Nome Descrição=nome do município.

private string sgUnidadeFederal

Notes: Tamanho=2

Nome=UF Descrição=sigla da unidade de federação.

4.17.5. Objeto XML Natureza

Consultar os diferentes tipos de natureza de obras. Detalhamento dos elementos do objeto XML para a natureza, que pode ser obtido por meio do método wsSICOP.ListarNatureza():

Attribute Details

private string cdClasse

Notes: Tamanho=3

Nome=Código Descrição=código da classe

private string deClasse

Notes: Tamanho=50

Nome=Descrição Descrição=descrição da classe


Notes: Tamanho=2

Nome=Unidade Medida Descrição=código da unidade de medida.

4.17.6. Objeto XML OrgaoSetor

Consultar os órgãos/setores existentes. Detalhamento dos elementos do objeto XML para o órgão/setor, que pode ser obtido por meio dos métodos wsSICOP.ListarOrgaoSetor() e wsSICOP.ListarBeneficiado():

Atributos Detalhes


50

private int cdOrgaoSetor

Tamanho=5 Nome=Código Descrição=código do órgão/setor.

private string nmOrgaoSetor

Notes: Tamanho=50

Nome=Descrição Descrição= descrição do órgão/setor.

private string sgOrgaoSetor

Notes: Tamanho=20

Nome=Sigla Descrição=sigla do órgão/setor.

4.17.7. Objeto XML TipoFotoObra

Consultar a classificação dos tipos de fotos de obras. Detalhamento dos elementos do objeto XML para o tipo de foto da obra, que pode ser obtido por meio do método wsSICOP.ListarTipoFoto():

Atributo Detalhes


Notes: Tamanho=3

Nome=Tipo de foto Descrição=informe o tipo de foto.

private string deFotoObra

Notes: Tamanho=50

Nome= Descrição Descrição= descrição da foto da obra.

4.17.8. Objeto XML TipoObra

Consultar a classificação dos tipos de obras. Detalhamento dos elementos do objeto XML para o tipo de obra, que pode ser obtido por meio do método wsSICOP.ListarTipoObra():

Atributo Detalhes

private int cdTipoObra

Notes: Tamanho=2

Nome=Tipo de Obra Descrição=código do tipo de obra.

private string

deTipoObra Notes: Tamanho=50

Nome=Descrição Descrição=descrição do tipo de obra.

4.17.9. Objeto XML TipoTitulo


51

Consultar a classificação dos tipos de títulos (contratos). Detalhamento dos elementos do objeto XML para o tipo de título, que pode ser obtido por meio do método wsSICOP.ListarTipoTitulo():

Atributo Detalhes

private int

cdEspTitulo Notes: Tamanho=3

Nome=Código Descrição=Código do Tipo de Título

private string deEspTitulo

Notes: Tamanho=50

Nome=Descrição Descrição=Descrição do Tipo de Título

4.17.10. Objeto XML UnidadeMedida

Consultar as unidades de medida que podem ser aplicadas à dimensão de uma obra. Detalhamento dos elementos do objeto XML para a unidade de medida, que pode ser obtido por meio do método wsSICOP.ListarUnidadeMedida():

Attribute Details


Notes: Tamanho=2

Nome=Unidade de Medida Descrição=código da unidade de medida.

private string deUnidMedida

Notes: Tamanho=50

Nome=Descrição Descrição=descrição da unidade de medida.

4.17.11. Objeto XML Cartório

Consultar os cartórios disponíveis para registro do imóvel do bem público. Detalhamento dos elementos do objeto XML para o cortório, que pode ser obtido por meio do método wsSICOP.ListarCartorio():

Attribute Details

private Integer cdCartorio

Notes: Tamanho=4 Nome=Código Descrição=Código do Cartório

private String deCartorio

Notes: Tamanho=255 Nome=Descrição Descrição=Descrição do Cartório

4.17.12. Objeto XML MotivoOcorrencia


52

Consultar os motivos de atraso do cronograma da medição, os motivos e formas de rescisão do contrato e os motivos da paralisação. Detalhamento dos elementos do objeto XML para o MotivoOcorrencia, que pode ser obtido por meio dos métodos wsSICOP.ListarMotivoAtraso(), wsSICOP.ListarMotivoRescisao(), wsSICOP.ListarFormaRescisao() e wsSICOP.ListarMotivoParalisacao():

Attribute Details

private integer cdMotivoOcorrencia

Notes: Tamanho=4 Nome=Código Descrição=Código do Motivo da Ocorrência

private String deMotivoOcorrencia

Notes: Tamanho=1000 Nome=Descrição Descrição=Descrição do Motivo da Ocorrência

4.17.13. Objeto XML TipoBemPublico

Consultar a classificação dos tipos de bem público. Detalhamento dos elementos do objeto XML para o tipo de bem público, que pode ser obtido por meio do método wsSICOP.ListarTipoBempublico():

Atributo Detalhes

private int cdTpBempublico

Notes: Tamanho=3

Nome=Código Descrição=Código do Tipo de Bem

private string deTpBempublico

Notes: Tamanho=50

Nome=Descrição Descrição=Descrição do Tipo de Bem

Sistema Integrado de Controle de Obras Públicas€¦ · obras, possam enviar seus dados para...

Documents

Transcript of Sistema Integrado de Controle de Obras Públicas€¦ · obras, possam enviar seus dados para...