Aller au contenu
ReadyZone Docs
Référence API

Nom de la zone

Retourner le nom et le libellé public de la zone pour le branding du portail.

GET /api/companies/public/{companyRef}/name

Accès : Public

Cas d'usage opérateur

Au chargement du portail, afficher automatiquement le nom de zone exact (ex: ED Center).

Paramètres

  • companyRef (path, obligatoire)

companyRef est une chaîne de caractères correspondant à la référence publique de la zone. Dans le code du portail, le placeholder local {ref} représente cette même valeur.

Corps de réponse

{
  "name": "ReadyZone Center",
  "label": "ReadyZone Center",
  "reference": "ed-center-68819"
}
AttributTypeNullableDescription
namestringNonNom principal de la zone.
labelstringOuiLibellé public de la zone.
referencestringNonRéférence publique retournée par l’API.

Codes de statut

  • 200 OK
  • 400 Bad Request (zone wifi non trouvée)

Sur cette page