Referência

Hóspedes (dados sensíveis)

As fichas dos hóspedes (documento de identificação, nacionalidade, data de nascimento, morada, preferências, lista negra), os ocupantes das reservas e o detalhe de uma reserva, que os inclui. São dados pessoais sensíveis: a chave só os alcança se o dono da empresa lhe deu, ao criá-la, acesso reforçado com um consentimento que cubra os hóspedes (versão 2 ou posterior), com endereços de rede e validade curta, e cada pedido fica registado. Ver Dados sensíveis.

Operação	O que faz
GET `/api/hospedagem/reservas/{id}`	Uma reserva completa: estadias, depósitos, ocupantes, movimentos e política.
POST `/api/hospedagem/reservas/{id}/ocupantes`	Acrescenta um ocupante (hóspede acompanhante) a uma reserva, com o documento de identificação.
DELETE `/api/hospedagem/ocupantes/{id}`	Remove um ocupante de uma reserva.
GET `/api/hospedagem/fichas/{clienteId}`	A ficha de um hóspede sem o documento: se é VIP, se está na lista negra e como se reconhece o documento.
POST `/api/hospedagem/fichas/{clienteId}/abrir`	Abre a ficha completa de um hóspede, com o número do documento.
PUT `/api/hospedagem/fichas/{clienteId}`	Guarda a ficha de um hóspede: documento, nacionalidade, data de nascimento, morada, profissão, preferências, VIP e lista negra.
GET `/api/hospedagem/fichas/{clienteId}/acessos`	Quem abriu a ficha de um hóspede e quando.

GET/api/hospedagem/reservas/{id}#

Uma reserva completa: estadias, depósitos, ocupantes, movimentos e política.

Permissão Hospedagem.Ler

Inclui os ocupantes, com o tipo de documento, o fim do número, a nacionalidade e a data de nascimento: por isso é uma operação de dados sensíveis.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/hospedagem/reservas/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/hospedagem/reservas/{id}/ocupantes#

Acrescenta um ocupante (hóspede acompanhante) a uma reserva, com o documento de identificação.

Permissão Hospedagem.FichasEditar
Idempotência aceita Idempotency-Key

nome, ehCrianca, documentoTipo, documentoNumero, nacionalidade e dataDeNascimento.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · OcupantePedido)

Campo	Tipo	Obrigatório	Significado
`nome`	texto	sim	O nome.
`ehCrianca`	verdadeiro/falso	sim
`documentoTipo`	texto ou nulo
`documentoNumero`	texto ou nulo
`nacionalidade`	texto ou nulo
`dataDeNascimento`	data (AAAA-MM-DD) ou nulo

Resposta

Devolve 201 com o id do registo criado.

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/hospedagem/reservas/<id>/ocupantes' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Idempotency-Key: <um-GUID-novo>' \
  -H 'Content-Type: application/json' \
  -d '{
  "nome": "texto",
  "ehCrianca": false
}'

DELETE/api/hospedagem/ocupantes/{id}#

Remove um ocupante de uma reserva.

Permissão Hospedagem.FichasEditar

Devolve 204, sem corpo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X DELETE 'https://<endereço-da-API>/api/hospedagem/ocupantes/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/hospedagem/fichas/{clienteId}#

A ficha de um hóspede sem o documento: se é VIP, se está na lista negra e como se reconhece o documento.

Permissão Hospedagem.Ler

Não mostra o número do documento nem regista acesso na ficha; o pedido fica registado como acesso sensível da chave.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`clienteId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/hospedagem/fichas/<clienteId>' \
  -H 'X-Api-Key: <a-sua-chave>'

POST/api/hospedagem/fichas/{clienteId}/abrir#

Abre a ficha completa de um hóspede, com o número do documento.

Permissão Hospedagem.FichasVer

Exige a permissão de ver fichas e fica registado quem a abriu e quando, além do registo de acesso sensível da chave.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`clienteId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl -X POST 'https://<endereço-da-API>/api/hospedagem/fichas/<clienteId>/abrir' \
  -H 'X-Api-Key: <a-sua-chave>'

PUT/api/hospedagem/fichas/{clienteId}#

Guarda a ficha de um hóspede: documento, nacionalidade, data de nascimento, morada, profissão, preferências, VIP e lista negra.

Permissão Hospedagem.FichasEditar

Devolve 204, sem corpo.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`clienteId`	no caminho	identificador (UUID)	sim

Corpo do pedido (JSON · GuardarFichaCommand)

Campo	Tipo	Obrigatório	Significado
`clienteId`	identificador (UUID)	sim	O cliente do documento.
`documentoTipo`	texto ou nulo
`documentoNumero`	texto ou nulo
`documentoValidade`	data (AAAA-MM-DD) ou nulo
`nacionalidade`	texto ou nulo
`dataDeNascimento`	data (AAAA-MM-DD) ou nulo
`morada`	texto ou nulo
`profissao`	texto ou nulo
`preferencias`	texto ou nulo
`vip`	verdadeiro/falso	sim
`vipMotivo`	texto ou nulo
`listaNegra`	verdadeiro/falso	sim
`listaNegraMotivo`	texto ou nulo
`notas`	texto ou nulo

Pedido

curl

curl -X PUT 'https://<endereço-da-API>/api/hospedagem/fichas/<clienteId>' \
  -H 'X-Api-Key: <a-sua-chave>' \
  -H 'Content-Type: application/json' \
  -d '{
  "clienteId": "00000000-0000-0000-0000-000000000000",
  "vip": false,
  "listaNegra": false
}'

GET/api/hospedagem/fichas/{clienteId}/acessos#

Quem abriu a ficha de um hóspede e quando.

Permissão Hospedagem.FichasVer

Parâmetros

Nome	Onde	Tipo	Obrigatório
`clienteId`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/hospedagem/fichas/<clienteId>/acessos' \
  -H 'X-Api-Key: <a-sua-chave>'