SpectacleListe
  • 19 May 2023
  • 1 Minute à lire
  • Sombre
    Lumière
  • PDF

SpectacleListe

  • Sombre
    Lumière
  • PDF

Résumé de l’article

Fonction API

/v1/ModuleSpectacle/SpectacleListe

Verbe HTTP

Post

Description

Permet de lister les spectacles d'un dossier à partir d'une date donnée

Groupe de fonctions API

SPECT01

Paramètres de la requête

ParamètreTypeDescription
dateDebutMinstring(date-time)Les spectacles qui remonteront dans la réponse seront ceux avec une date de début supérieure à la date renseignée dans ce paramètre
numeroDossierstring

Numéro du dossier concerné par la requête

Paramètres de la réponse

ParamètreTypeDescription
spectaclesSpectacle[]Liste d'éléments structurés contenant les informations des spectacles trouvés (cf. détail ci-dessous)

Spectacle

ParamètreTypeDescription
nomInterneEtablissementstringNom interne de l'établissement auquel est rattaché le spectacle
axeAnalytiquestringIl est possible de rattacher le spectacle à 3 axes analytiques. Ce paramètre définit le premier axe analytique
valeurAxeAnalytiquestringIndique à quelle valeur de l'axe analytique 1 est rattaché le spectacle
axeAnalytique2stringIl est possible de rattacher le spectacle à 3 axes analytiques. Ce paramètre définit le deuxième axe analytique
valeurAxeAnalytique2stringIndique à quelle valeur de l'axe analytique 2 est rattaché le spectacle
axeAnalytique3stringIndique à quelle valeur de l'axe analytique 3 est rattaché le spectacle
valeurAxeAnalytique3stringIl est possible de rattacher le spectacle à 3 axes analytiques. Ce paramètre définit le troisième axe analytique
referenceExterneSpectaclestringIdentifiant externe du spectacle trouvé
numeroObjetstringNuméro objet du spectacle
intituleSpectaclestringIntitulé du spectacle
dateDebutstring(date-time)Date de début du spectacle
dateFinstring(date-time)Date de fin du spectacle

Requête

{
  "dateDebutMin": "2020-10-14T21:46:24",
  "numeroDossier": "string"
}

Réponse

{
  "spectacles": [
    {
      "nomInterneEtablissement": "string",
      "axeAnalytique": "string",
      "valeurAxeAnalytique": "string",
      "axeAnalytique2": "string",
      "valeurAxeAnalytique2": "string",
      "axeAnalytique3": "string",
      "valeurAxeAnalytique3": "string",
      "referenceExterneSpectacle": "string",
      "numeroObjet": "string",
      "intituleSpectacle": "string",
      "dateDebut": "2020-10-14T21:46:24",
      "dateFin": "2020-10-14T21:46:24"
    },
    {
      "nomInterneEtablissement": "string",
      "axeAnalytique": "string",
      "valeurAxeAnalytique": "string",
      "axeAnalytique2": "string",
      "valeurAxeAnalytique2": "string",
      "axeAnalytique3": "string",
      "valeurAxeAnalytique3": "string",
      "referenceExterneSpectacle": "string",
      "numeroObjet": "string",
      "intituleSpectacle": "string",
      "dateDebut": "2020-10-14T21:46:24",
      "dateFin": "2020-10-14T21:46:24"
    }
  ]
}

Messages d'erreur

ErreurMessageDescription

Cet article vous a-t-il été utile ?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.