Aller au contenu
ReadyZone Docs
Référence API

Services publics

Lister les services publics d’une zone.

GET /api/services/public?companyRef={companyRef}

Accès : Public

Cas d’usage portail

Charger les services actifs proposés par la zone dans le portail captif.

Paramètres

  • companyRef (query, optionnel)

Réponse

La réponse est un tableau JSON de services publics actifs.

AttributTypeNullableDescription
idstring (UUID)NonIdentifiant du service.
iconstringOuiNom ou référence de l’icône.
titlestringNonTitre du service.
descriptionstringNonDescription affichée.
ctaLabelstringOuiLibellé de l’action.
ctaUrlstringOuiURL de l’action.
displayOrdernumberNonOrdre d’affichage.
isActivebooleanNonÉtat d’activation.

Codes de statut

  • 200 OK
  • 400 Bad Request (référence invalide)

Sur cette page