Serviço Holiday

Devolve uma lista de feriados nacionais, regionais e municipais para um determinado ano. Suporta o cálculo dos feriados para os anos entre 1582 e 2299.

Descarregar Contrato WSDL do Serviço

Descarregar Guia de Iniciação Rápida

Serviço	Operação	Descrição
Holiday	GetAllHolidays	Devolve uma lista com todos os feriados (nacionais, regionais e municipais) para um determinado ano.
	GetCarnival	Devolve a data do Carnaval para um determinado ano
	GetCorpusChristi	Devolve a data do Dia de Corpo de Deus para um determinado ano
	GetEaster	Devolve a data da Páscoa para um determinado ano
	GetGoodFriday	Devolve a data da Sexta-Feira Santa para um determinado ano
	GetHolidaysByMunicipalityId	Devolve a lista de feriados para um determinado ano e código de município e opcionalmente inclui os feriados nacionais nos resultados
	GetLocalHolidays	Devolve a lista de feriados municipais para um determinado ano
	GetNationalHolidays	Devolve todos os feriados nacionais para um determinado ano.
	GetRegionalHolidays	Devolve a lista de feriados regionais para um determinado ano

Serviço Holiday

GetAllHolidays

Devolve uma lista com todos os feriados (nacionais, regionais e municipais) para um determinado ano.

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter os feriados.

Parâmetros de resposta

GetAllHolidaysResult : ArrayOfHoliday (opcional)

Um array de Holiday.

Exemplo SOAP

O exemplo seguinte mostra como obter os feriados de Portugal para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter os feriados de Portugal para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetCarnival

Devolve a data do Carnaval para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter o feriado.

Parâmetros de resposta

GetCarnivalResult : Holiday (opcional)

O feriado.

Exemplo SOAP

O exemplo seguinte mostra como obter a data do feriado de Carnaval para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter a data do feriado de Carnaval para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetCorpusChristi

Devolve a data do Dia de Corpo de Deus para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter o feriado.

Parâmetros de resposta

GetCorpusChristiResult : Holiday (opcional)

O feriado.

Exemplo SOAP

O exemplo seguinte mostra como obter a data do feriado do Dia de Corpo de Deus para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter a data do feriado do Dia de Corpo de Deus para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetEaster

Devolve a data da Páscoa para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter o feriado.

Parâmetros de resposta

GetEasterResult : Holiday (opcional)

O feriado.

Exemplo SOAP

O exemplo seguinte mostra como obter a data do feriado da Páscoa para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter a data do feriado Dia da Páscoa para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetGoodFriday

Devolve a data da Sexta-Feira Santa para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter o feriado.

Parâmetros de resposta

GetGoodFridayResult : Holiday (opcional)

O feriado.

Exemplo SOAP

O exemplo seguinte mostra como obter a data do feriado de Sexta-Feira Santa para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter a data do feriado de Sexta-Feira Santa para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetHolidaysByMunicipalityId

Devolve a lista de feriados para um determinado ano e código de município e opcionalmente inclui os feriados nacionais nos resultados

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter os feriados.

municipalityId : string (mandatório)

O identificador do município, de acordo com o serviço SAPO GIS, do qual pretende obter os feriados

includeNational : boolean (opcional)

Indica se deseja ou não que os feriados nacionais sejam incluídos.

Parâmetros de resposta

GetHolidaysByMunicipalityIdResult : ArrayOfHoliday (opcional)

Um array de Holiday.

Exemplo SOAP

O exemplo seguinte mostra como obter os feriados para um determinado município e ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter os feriados para um determinado município e ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetLocalHolidays

Devolve a lista de feriados municipais para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter os feriados locais.

Parâmetros de resposta

GetLocalHolidaysResult : ArrayOfHoliday (opcional)

Um array de Holiday.

Exemplo SOAP

O exemplo seguinte mostra como obter os feriados municipais para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter os feriados municipais para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetNationalHolidays

Devolve todos os feriados nacionais para um determinado ano.

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter os feriados nacionais.

Parâmetros de resposta

GetNationalHolidaysResult : ArrayOfHoliday (opcional)

Um array de Holiday.

Exemplo SOAP

Devolve a lista de feriados nacionais para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter os feriados nacionais para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

GetRegionalHolidays

Devolve a lista de feriados regionais para um determinado ano

Parâmetros do pedido

year : int (mandatório)

O ano do qual quer obter os feriados regionais.

Parâmetros de resposta

GetRegionalHolidaysResult : ArrayOfHoliday (opcional)

Um array de Holiday.

Exemplo SOAP

Devolve a lista de feriados regionais para um determinado ano: E a correspondente resposta com sucesso:

Exemplo HTTP GET

O exemplo seguinte mostra como obter os feriados regionais para um determinado ano: E a correspondente resposta com sucesso:

Voltar ao topo

Holiday Entidades

ArrayOfHoliday

Nome do atributo	Descrição
Lista de Holiday : Holiday (opcional)	Um array de Holiday.

Voltar ao topo

Holiday

Nome do atributo	Descrição
Name : string (opcional)	O nome do feriado.
Date : dateTime (opcional)	A data do feriado.
Description : string (opcional)	A descrição do feriado.
Type : HolidayType (opcional)	O tipo do feriado.
Municipality : Municipality (opcional)	O município do feriado.

Voltar ao topo

HolidayType

Valor	Descrição
National	Indica que o feriado é nacional.
Municipal	Indica que o feriado é apenas a nível do município.
Regional	Indica que o feriado é apenas a nível da região.
Religious	Indica que o feriado é religioso.
Optional	Indica que o feriado é opcional.

Voltar ao topo

Municipality

Nome do atributo	Descrição
Id : string (opcional)	O identificador do município de acrodo com o serviço SAPO GIS.
Name : string (opcional)	O nome do município.

Voltar ao topo

Autenticação de um pedido SOAP

Cada pedido deverá conter informação de autenticação para estabelecer a identidade de quem fez o pedido e o token de autorização chamado ESB AccessKey (chave de acesso).

ESB Access Key

Inserir caminho para obter a chave de acesso.

A autorização do uso da API é efectuada através da chave de acesso (ESBAccessKey) que é disponibilizada no final do processo de compra do produto.

Na sua área de cliente encontrará nos detalhes do produto a geração de chaves de acesso que podem ser geradas para si, para outros utilizadores da API registados no SAPO Services ou então por qualquer utilizador.

O elemento "ESBAccessKey" deverá aparecer num SOAP Header da mensagem após o SOAP Header "ESBCredentials".

Exemplo:

ESBCredentials

ESBCredentials é um tipo complexo que é usado para passar as credenciais de modo a autenticar o pedido SOAP.

Elemento	Descrição
ESBUsername	O email da conta usada para para acederà API.
ESBPassword	A palavra-passe que corresponde à conta de email especificada em ESBUsername.
ESBToken	O token de acesso que representa as credenciais (ESBUsername + ESBPassword) usadas para comprar o uso da API.

Pedido com ESBUsername e ESBPassword

Pedido com ESBToken

Usar um ESBToken ao invés do ESBUsername e ESBPassword pode ser útil se não pretende dar as suas credenciais a quem está a usar a API.

Para gerar um ESBToken deverá usar o serviço SAPO STS (Security Token Service). O ESB Token é válido por 12 horas.

Obter um ESB Token:

Resposta:

Token: id42ho234iwh234odihwdw786576413a3836467b94f8c2991f(...)wdwqdqwd

Voltar ao topo