Aller au contenu

Horários livres e ocupados por recurso

GET/api/bookings/availability

Auth
Jeton requis
Clé d’API:
bookings:read
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Para cada recurso do space, os horários do dia (ou de até 7 dias) calculados do horário semanal, das exceções e das reservas. Cada horário livre traz o custo em créditos (`creditCost`, `priceMode`) e `canAfford` (falso também quando a variável de plataforma `credits.useWhileSubscriptionInactive` está desligada e o plano está em atraso ou pausado, a mesma regra do `POST /api/bookings`). Com vínculo vivo a uma empresa não encerrada, o saldo da empresa também conta: `affordableWith` diz qual carteira cobre (`own` primeiro, depois `company`, o mesmo `payWith` de `POST /api/bookings`; `null` quando nenhuma) e `companyWallet` traz `{ companyId, name, balance }` (nulo sem empresa que possa pagar). `balance` é o saldo próprio de quem chama. Nunca traz quem reservou, salvo `showBookerName` ligado no space (só o nome).

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirequerystring (uuid)
datefacultatifquerystringDia local; padrão hoje.
daysfacultatifqueryinteger
resourceIdfacultatifquerystring (uuid)
hostMemberIdfacultatifquerystring (uuid)
durationMinutesfacultatifqueryintegerPadrão: a duração mínima do recurso.

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Réponses

StatutDescription
200Grade por recurso e por dia (`resources`), mais `balance` e `companyWallet` de quem chama.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

curl -X GET "https://api.memberfy.net/api/bookings/availability" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"