e-GAR - Guia Eletrónica de Acompanhamento de Resíduos - SRIR - Sistema Regional de Informação sobre Residuos - SRAAC

Home / e-Gars / Webservices / Documentação

Guias Eletrónicas de Acompanhamento de Resíduos

Portaria n.º 1879/2017 de 19 de dezembro

Introdução

Num contexto de simplificação administrativa, de procedimentos e de incremento da rastreabilidade dos movimentos dos resíduos, surge a desmaterialização às guias de acompanhamento de resíduos, criando a Guia Eletrónica de Acompanhamento de Resíduos (e-GAR), que substitui as atuais guias em papel e permite a integração automática de dados nos mapas anuais de registo do SRIR (após validação e responsabilização do utilizador autenticado).

Tipologias das e-Gars

A plataforma do SRIR implementa duas tipologias de e-Gars distintas, de acordo com o destino final dos resíduos.

As e-Gars com destino final da Região Autónoma dos Açores, são destinadas a todos os transportes de resíduos (que carecem de e-Gar) cujo destino final dos resíduos transportados seja um operador de gestão de resíduos localizadao na região. As e-Gars são caracterizadas por serem preenchidas única e exclusivamente com entidades presentes na plataforma SRIR e pela possibilidade de serem indicados um ou mais códigos LER numa só guia.

As e-Gars com destino final no Continente, são destinadas a todos os transportes de resíduos (que carecem de e-Gar) cujo destino final dos resíduos transportados seja um operador de gestão de resíduos a operar fora da RAA. As e-Gars são caracterizadas por serem preenchidas nos dados do operador de gestão de resíduos, por um operador existente no siliamb, pela indicação de pelo menos um transportador fora da região também existente no siliamb, e pela indicação de apenas um código LER de resíduo transportado por e-Gar. Todas as e-Gars emitidas com destino final no continente, originam também um e-Gar nacional (emitida pela APA através do siliamb) que é anexa à e-Gar regional emitida.

Fluxograma de uma e-Gar

Uma e-Gar durante o seu período de vida, transita entre diversos intervenientes, estados e operações. O fluxograma demonstra uma visão geral do processo.

Webservices

O SRIR disponibiliza um conjunto de webservices, com o objetivo de permitir a interoperabilidade com soluções desenvolvidas pelos utilizadores da plataforma, destinados à gestão e emissão de e-Gars de forma autónoma.

Acesso

O acesso aos webservices é efetuado mediante a atribuição de uma chave de segurança (token), a todas as entidades que pretendam efetuar a comunicação com a plataforma SRIR através dos seus sistemas de informação.

O pedido de acesso é efetuado via preenchimento do formulário disponibilizado através da área de formulários no SRIR, podendo ser também submetido clicando aqui.

Endpoints

Os webservices encontram-se disponíveis através de dois endpoints dependendo do tipo de utilização que estiver a ser efetuado. Para cada endpoint, existe um token de acesso específico.

Na 1.ª fase de integração, deverá ser utilizado o webservice endpoint do ambiente de desenvolvimento, disponível no endereço
https://devsrir.azores.gov.pt/egar/wsv1.asmx, com a respetiva descrição do serviço WSDL.

Após o processo de implementação estar concluído, será disponibilizado um novo token de acesso que dará acesso ao webservice endpoint do ambiente de produção.

Métodos

Os webservices disponibilizam as seguintes operações/métodos:

Método	Descrição
aceitarGuia	Método para o Operador de Gestão de Resíduos aceitar uma guia emitida
anularGuia	Método para anular uma guia criada pela entidade
autorizarGuia	Método para o Produtor/Detentor autorizar uma guia emitida pelo Transportador ou Operador de Gestão de Resíduos
confirmarCorrecaoGuia	Método para o Produtor/Detentor confirmar a correção de uma guia corrigida pelo Operador de Gestão de Resíduos
consultaEstabelecimentosAPA	Método para consulta através do NIF de Entidades registadas na APA
consultaEstabelecimentosSRIR	Método para consulta através do NIF de Entidades registadas no SRIR
consultarGuia	Método para consultar os detalhes de uma guia
consultarGuias	Método para consultar uma listagem das guias em que intervêm.
consultarGuiasObra	Método para consultar uma listagem das guias contendo um Código de Obra.
corrigirGuia	Método para corrigir os resíduos de uma guia emitida
emitirGuiaNAC	Método para emitir uma guia com destino final fora da RAA
emitirGuiaRAA	Método para emitir uma guia com destino final na RAA
negarCorrecaoGuia	Método para o Produtor/Detentor negar a correção de uma guia corrigida pelo Operador de Gestão de Resíduos
rejeitarGuia	Método para Operador de Gestão de Resíduos rejeitar uma guia

aceitarGuia

Método para o Operador de Gestão de Resíduos aceitar uma guia emitida.

As guias que se encontram no estado Emitida ou com correções negadas por parte do Produtor/Detentor, aguardam uma ação por parte do Operador de Gestão de Resíduos. O OGR pode aceitar, corrigir ou rejeitar a guia. Esse método permite ao OGR aceitar a guia, passando para o estado Concluída ou Aceite caso o Produtor/Detentor não ainda tenha autorizado a guia digitalmente (para as guias emitidas na qualidade de transportador ou OGR).

aceitarGuiaInput

Elemento	Obr.	Qt	Tipo	Descrição
tokenEntidade	Sim	1	String	Token de acesso ao webservice que identifica a entidade que invoca o método. O token consiste num UUID.
dataHoraFimTransporte	Sim	1	DateTime	Data e hora do fim do transporte.
idGuia	Sim	1	Complexo	Estrutura do tipo idGuia que identifica a guia a ser aceite.

aceitarGuiaOutput

Elemento	Qt	Tipo	Descrição
Result	1	Complexo	Estrutura do tipo Result que descreve o resultado da operação.
erroList	0..n	Complexo	Estrutura do tipo Erro que descreve os erros encontrados na operação.
guia	Sim	1	Complexo	Estrutura do tipo guiaDetalhe que devolve os dados da guia após operação.

Pedido

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsv1="https://srir.azores.gov.pt/egar/wsv1">
    <soapenv:Header/>
    <soapenv:Body>
        <wsv1:aceitarGuia>
            <wsv1:agi>
            <wsv1:idGuia>
                <wsv1:numeroGuia>AZ2018080936307</wsv1:numeroGuia>
                <wsv1:codigoVerificacao>a9f4013110994e76</wsv1:codigoVerificacao>
            </wsv1:idGuia>
            <wsv1:tokenEntidade>79922849-5690-4549-A0D7-2AA36DFF7900</wsv1:tokenEntidade>
            <wsv1:dataHoraFimTransporte>2018-08-10T09:30:00</wsv1:dataHoraFimTransporte>
            </wsv1:agi>
        </wsv1:aceitarGuia>
    </soapenv:Body>
</soapenv:Envelope>

Resposta

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <aceitarGuiaResponse xmlns="https://srir.azores.gov.pt/egar/wsv1">
         <aceitarGuiaResult>
            <Result>
               <Codigo>100</Codigo>
               <desResultado>Ok</desResultado>
            </Result>
            <erroList/>
            <guia/>
         </aceitarGuiaResult>
      </aceitarGuiaResponse>
   </soap:Body>
</soap:Envelope>

Elemento	Obr.	Qt	Tipo	Descrição
numeroGuia	Sim	1	String	Código do documento (ex: AZ2018062731042).
codigoVerificacao	Sim	1	String	Código de verificação.

Elemento	Obr.	Qt	Tipo	Descrição
Codigo	Sim	1	String	Código resultado da operação (100 ou 200).
desResultado	Sim	1	String	Descrição do código do resultado (Ok ou N_Ok)

Elemento	Obr.	Qt	Tipo	Descrição
Codigo	Sim	1	String	Código do erro da operação. Ver Códigos de erros.
descErro	Sim	1	String	Descrição do código do erro.

Elemento	Qt	Tipo	Descrição
nif	1	String	Número de identificação fiscal.
codigoAPA	1	String	Código APA único para cada entidade/estabelecimento.
entidade	1	String	Nome da entidade.
estabelecimento	1	String	Nome do estabelecimento.
moradaSede	1	String	Morada.
localidadeSede	1	String	Localidade.
codPostalSede	1	String	Código Postal.

Elemento	Qt	Tipo	Descrição
id_entidade	1	String	UUID da entidade/estabelecimento.
NIF	1	String	Número de identificação fiscal.
Entidade	1	String	Nome da entidade.
Estabelecimento	1	String	Nome do estabelecimento.
Morada	1	String	Morada.
Localidade	1	String	Localidade.
CP	1	String	Código Postal.
Concelho	1	String	Concelho.

Elemento	Qt	Tipo	Descrição
gru	1	Boolean	Indica se a guia pertence à gestão de resíduos urbanos. Só deve ser verdadeiro se a guia for emitida para efeitos de transporte de resíduos urbanos.
tipoProdutor	1	String	(Obsoleto. Será removido no futuro.) Indica se o Produtor/Detentor dos resíduos é um (PI) Produtor Inicial ou um (OGR) Operador de Gestão de Resíduos. Essencial para a migração da guia para os mapas de registo de resíduos disponíveis no SRIR.
tipoInterveniente	1	String	Indica se a guia está a ser emitida na qualidade de (P)rodutor, (T)ransportador ou (D)estinatário
produtorDetentor	1	Complexo	Estrutura do tipo produtorDetentor que indica os dados do Produtor/Detentor da guia.
residuosTransportados	1..n	Complexo	Estrutura do tipo residuoTransportado que indica a lista de resíduos transportados na guia.
transportadores	1..n	Complexo	Estrutura do tipo transportador que indica a lista de transportadores dos resíduos.
operadorGestaoResiduos	1	Complexo	Estrutura do tipo operadorGestaoResiduos que indica os dados do Operador de Gestão de Resíduos da guia.

Elemento	Qt	Tipo	Descrição
nOrdem	1	Int	Número de ordem do resíduo transportado na guia.
codigoResiduoLer	1	String	Código LER do resíduo transportado.
designacao	0..1	String	Designação do resíduo transportado. Se não presente, designação associada ao código LER.
codigoGrupo	1	String	Código do grupo de resíduos (I, II, III, IV, IV_CP) quando aplicável.
quantidade	1	Double	Quantidade do resíduo transportado.
codigoOperacao	1	String	Código da operação realizada.

Elemento	Qt	Tipo	Descrição
nOrdem	1	Int	Número de ordem do transportador na guia.
id_entidade	1	String	UUID da entidade/estabelecimento do transportador no SRIR. (Não preencher caso o transportador seja fora da RAA.)
nif	1	String	NIF do transportador.
entidade	1	String	Nome do transportador.
matricula	1	String	Matrícula do veículo.
dataHoraInicioTransporte	1	String	Data e hora do início do transporte.

Elemento	Qt	Tipo	Descrição
id_entidade	1	String	UUID da entidade/estabelecimento do Operador de Gestão de Resíduos no SRIR. (Não preencher caso a guia seja emitida com destino final fora da RAA.)
codigoAPA	1	String	Código APA do Operador de Gestão de Resíduos caso a guia seja emitida com destino final fora da RAA.
nif	1	String	NIF da entidade/estabelecimento.
nome	1	String	Nome da entidade.
estabelecimento	1	String	Nome do estabelecimento.
morada	1	String	Morada da entidade/estabelecimento.
localidade	1	String	Localidade da morada.
codigoPostal	1	String	Código postal da morada.
concelho	1	String	Concelho da morada.

Código	Descrição
00	Ocorreu um erro ao efetuar a operação. Por favor, tente novamente.
01	O token da Entidade é obrigatório.
02	Não foi possível encontrar a Entidade deste token.
03	O token não se encontra activo.
04	O número da guia é obrigatório.
05	O código de verificação da guia é obrigatório.
06	Não foi possível encontrar a guia com esses códigos.
07	A entidade não possui permissões para aceder a esta guia.
08	Para aceitar a guia tem de ser o Operador de Gestão de Resíduos.
09	Só é possível aceitar guias emitidas ou com correções negadas.
10	Para autorizar a e-Gar tem de ser o Produtor/Detentor e a mesma ainda não pode ter sido autorizada.
11	Só é possível rejeitar guias emitidas/anuladas.
12	Só é possível anular guias emitidas pela entidade.
13	Só é possível anular guias emitidas ainda não corrigidas/rejeitadas/anuladas.
14	Não foram encontrados estabelecimentos com este NIF.
15	Não foram encontrados estabelecimentos na APA com este NIF.
16	Para aceitar tem de ser o produtor/detentor e a guia tem de encontrar no estado corrigida.
17	Para negar a correção tem de ser o produtor/detentor e a guia tem de encontrar no estado corrigida.
18	As e-Gars emitidas para efeitos de gestão de resíduos urbanos só permitem os códigos LER das classes 17, 20, 1501*, 160103, 160601 e 130208.
19	É necessário um transportador do resíduo.
20	É necessário um resíduo transportado.
21	A data inicial do transporte não pode ser inferior a 10 dias da data de emissão da guia.
22	A data de cada transporte tem de ser posterior à data do transporte anterior.
23	É necessário indicar o tipo de interveniente (P: Produtor, T: Transportador, D: Destinatário).
24	Introduza o ID do produtor/detentor dos resíduos.
25	Introduza a morada da obra RCD.
26	Introduza a morada da Prestação de Serviços.
27	Introduza o ID do operador de gestão de resíduos.
28	Não foi possível encontrar esse produtor de resíduos como entidade no SRIR.
29	Não foi possível encontrar esse operador de gestão de resíduos como entidade no SRIR.
30	O código da operação do resíduo transportado é obrigátorio.
31	O código de operação é inválido.
32	Não foi encontrado a entidade deste transportador no SRIR (nome_da_entidade).
33	Não é possível autorizar e-Gars anuladas.
34	O número de elementos não pode ultrapassar os 200.
35	Só é possível corrigir guias emitidas ou com correções rejeitadas.
36	Indique pelo menos um resíduo a corrigir.
37	Introduza o ID do transportador.
38	Uma guia com destino final no Continente não pode emitida pelo destinatário no SRIR.
39	É obrigatório indicar apenas um resíduo transportado.
40	É necessário indicar um transportador fora da RAA.
41	É necessário indicar o código APA do operador de gestão de resíduos.
42	Só é possível alterar a data do último transporte a guias com destino final fora da RAA.
43	Introduza o código da obra RCD.
44	O token não permite essa operação.
98	Erro de consulta por estabelecimentos na APA. Descrição do erro na APA.
99	Interface não disponível.

Código	Descrição
EM	Emitida
AC	Aceite
CO	Corrigida
RJ	Rejeitada
CN	Correção Negada
CC	Concluída
AN	Anulada

Data	Descrição
17-07-2023	Atualização da estrutura produtorDetentor. Atualização do campo tipoRemetente. Introdução dos campos vfvProprietario,vfvMatricula.
28-02-2023	Método implementado consultarGuiasObra.
18-09-2022	Atualização da estrutura produtorDetentor. Introdução do campo codigoObra. Atualização da documentação.
12-02-2021	Método implementado alterarUltimoTransporte. Atualização da estrutura guiaNAC, campo retomaEG. Atualização da documentação.
23-01-2021	Método implementado emitirGuiaNAC. Nova estrutura: guiaNAC. Atualização da estrutura: operadorGestaoResiduos. Atualização da documentação.
12-05-2020	Atualização da estrutura residuoTransportado, campo codigoResiduoLer
27-04-2020	Atualização do método corrigirGuia com informações sobre a remoção de resíduos.
02-12-2019	Atualização do valor do campo designacao em residuosTransportados.
17-11-2019	Atualização da validação das datas dos transportadores.
03-05-2019	Atualização das seguintes estruturas: aceitarGuiaOutput, anularGuiaOutput, autorizarGuiaOutput, confirmarCorrecaoGuiaOutput, negarCorrecaoGuiaOutput, rejeitarGuiaOutput. Foi adicionado o tipo complexo guiaDetalhe a todos os valores de retornos das estruturas acima indicadas. O tipo complexo guiaDetalhe foi atualizado para incluir o dado da data do fim do transporte.
01-03-2019	Atualização da estrutura: guiaRAA. O campo tipoProdutor deixou de ser utilizado, não sendo necessário mais o seu preenchimento. Remoção do campo tipoProdutor da estrutura guiaDetalhe.
20-02-2019	Atualização do método: corrigirGuia. Atualização da documentação.
14-12-2018	Novo método: consultarGuias.
12-12-2018	Publicação da documentação referente aos métodos consultarGuia e emitirGuiaRAA. No método emitirGuiaRAA, o campo gru passou a ser opcional. O tipo complexo guiaDetalhe foi atualizado para incluir os dados do produtor, transportadores, operador de gestão de resíduos e outros dados da guia.
14-12-2018	Documento inicial.

Guias Eletrónicas de Acompanhamento de Resíduos

Portaria n.º 1879/2017 de 19 de dezembro

Introdução

Tipologias das e-Gars

Fluxograma de uma e-Gar

Webservices

Acesso

Endpoints

Métodos

aceitarGuia

anularGuia

autorizarGuia

confirmarCorrecaoGuia

consultaEstabelecimentosAPA

consultaEstabelecimentosSRIR

consultarGuia

consultarGuias

consultarGuiasObra

corrigirGuia

emitirGuiaNAC

emitirGuiaRAA

negarCorrecaoGuia

rejeitarGuia

alterarUltimoTransporte

Tipos de Dados

Códigos de erros

Estados

Alterações