Documentation
Documentatie
1. Schéma global
1. Algemeen schema
- Requête
- Réponse
2. API CQL
2. CQL API
Recherche
Zoeken
- Requête Verzoek
- Réponse Antwoord
Recherche des valeurs distinctes
Zoeken op afzonderlijke waarden
- Requête Verzoek
- Réponse Antwoord
3. API SCAPIN
3. SCAPIN API
Informations générales
Algemene informatie
- Requête Verzoek
- Réponse Antwoord
Equipe
Team
- Requête Verzoek
- Réponse Antwoord
Producteurs
Producenten
- Requête Verzoek
- Réponse Antwoord
Documents
Documenten
- Requête Verzoek
- Réponse Antwoord
Tournées
Tournees
- Requête Verzoek
- Réponse Antwoord
4. API WEB
4. WEB API
Galerie
Galerij
- Requête Verzoek
- Réponse Antwoord
APIs : accès open data API’s: toegang tot open data
Le projet Scapin, plus qu'un moteur de recherche
Het SCAPIN-project, meer dan een zoekmachine
Comme son nom l'indique, le projet Scapin est centré sur le concept d'API. En effet, son objectif principal est de donner accès à ses données de la mémoire des arts de scène non seulement via un classique search engine, mais aussi directement via diverses APIs.
Zoals de naam al aangeeft, is SCAPIN gebaseerd op het principe van API. Het belangrijkste doel is namelijk om niet alleen toegang te bieden tot de gegevens van het geheugen van de podiumkunsten via een klassieke zoekmachine, maar ook rechtstreeks via verschillende API’s.
Contrairement aux moteurs de recherche, les APIs fournissent via des urls spécifiques les données dans un format ouvert, qui n'est pas destiné à la lecture par un être humain, mais par une autre application informatique, bureautique ou web. Tout développeur d'applications desktop ou mobile ou de websites, après avoir enregistré son projet auprès de Scapin, peut donc y utiliser les données en question, au format et dans le design de son choix.
In tegenstelling tot zoekmachines leveren API’s gegevens via specifieke URL’s in een open format dat niet bedoeld is voor menselijke lezers, maar voor computerprogramma’s en webapplicaties. Elke ontwikkelaar van desktop- of mobiele toepassingen en websites kan, na registratie van zijn project bij SCAPIN, de betreffende gegevens gebruiken in een formaat en ontwerp naar keuze.
1. Schéma global 1. Algemeen schema
Schéma unique, usages multiples
Uniek schema, verschillende toepassingen
Toutes les APIs nécessaires pour accéder aux données de la mémoire des arts de scène de SCAPIN sont interrogeables via des URLs au schéma identique. Les pages suivantes les exposent en détails.
Alle API’s die nodig zijn om toegang te krijgen tot de gegevens van het geheugen van de podiumkunsten van SCAPIN zijn opvraagbaar via URL’s die een identiek schema volgen. Hoe dit in zijn werk gaat, wordt in de volgende pagina’s in detail uiteengezet.
Structure de la requête :
Structuur van het verzoek:
[site]/[nom]/[service]/[accès]/[méthode]/[paramètre unique]?[paramètres multiples]
[site]/[naam]/[service]/[toegang]/[modus]/[unieke parameter]?[verschillende parameters]
[site]
[site]/div>
[nom]
[naam]
Nom de l'API à laquelle on désire accéder. Concrètement, le projet SCAPIN utilise trois APIs : CQL pour les recherches, Scapin proprement dite pour toutes les informations détaillant un spectacle et Web pour les fichiers liés aux spectacles et accessibles via le web.
Naam van de API waartoe men toegang wil verkrijgen. SCAPIN maakt gebruik van drie API’s: CQL voor de zoekopdrachten, SCAPIN zelf voor de informatie over voorstellingen en Web voor de bestanden die gerelateerd zijn aan voorstellingen en toegankelijk zijn via het web.
[service]
[service]
Nom du WebService (extension .svc) auquel on désire accéder.
Naam van de webservice (extensie .svc) waartoe men toegang wil verkrijgen.
[accès
[toegang]]
Peut prendre deux valeurs : anon, pour les accès publics, ou auth, pour les accès avec identification préalable (réservés aux partenaires du projet).
Toegang kan twee waarden aannemen: anon voor de publieke toegang of auth voor de toegang met voorafgaande identificatie (voorbehouden voor de partners van het project).
[méthode]
[modus]
Seules les méthodes de lecture de données (commençant par Get) sont accessibles via les accès publics, tandis que les accès avec identification pourront recourir aux méthodes d'écriture de données (Post, Put et Delete).
Alleen de leesmodus (die begint met Get) is toegankelijk voor het publiek, terwijl de schrijfmodus (die begint met Post, Put of Delete, afhankelijk van de opdracht) alleen toegankelijk is na voorafgaande identificatie.
[paramètre unique]
[unieke parameter]
Les paramètres uniques - typiquement, les IDs uniques de spectacles - sont simplement précédés d'un "/".
De unieke parameter – meestal de unieke ID van een voorstelling – wordt voorafgegaan door een “/”.
[paramètres multiples]
[verschillende parameters]
Les méthodes qui attendent plus d'un paramètres sont suivies d'un "?" ; les paramètres eux-mêmes, sous la forme "nom=valeur", sont séparés par "&".
Wanneer een modus meer dan één parameter verwacht, wordt deze gevolgd door een "?". De verschillende parameters, in de vorm van "nom=valeur", worden gescheiden door "&".
Request Header requis Request header vereist
nom
naam
"AppName"
valeur
waarde
Nom de l'application autorisée à utiliser les données de Scapin. Cette autorisation peut être obtenue gratuitement, sur simple demande.
Naam van de toepassing die toestemming heeft om de gegevens van SCAPIN te gebruiken. Deze toestemming kan gratis op aanvraag worden verkregen.
2. API CQL 2. CQL API
Recherche Zoeken
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/cql/sru.svc/anon/get?db=scapin.s&q=[requête CQL]&resultFields=[informations renvoyées]&sortBy=[tri]&page=[page de résultats]&rows=[nb de résultats par page]
https://api.aml-cfwb.be/cql/sru.svc/anon/get?db=scapin.s&q=[CQL-verzoek]&resultFields=[teruggestuurde informatie]&sortBy=[sorteren]&page=[resultatenpagina]&rows=[aantal resultaten per pagina]
[requête CQL]
[CQL-verzoek]
Requête selon l'implémentation CQL de Scapin, qui permet, via le protocole SRU, des recherches simples "plein texte", mais aussi multi-critères combinatoires (avec opérateurs AND, OR, NOT, PROX). Les partenaires référencés de SCAPIN ont accès à Phormion, dont l'interface de recherche permet de générer toutes les équations CQL supportées.
Verzoek volgens de CQL-implementatie van SCAPIN, die via het SRU-protocol zowel eenvoudige full text-zoekopdrachten als complexe zoekopdrachten op basis van verschillende criteria (met de operatoren AND, OR, NOT en PROX) mogelijk maakt. Geregistreerde partners bij SCAPIN hebben toegang tot Phormion, waarvan de zoekinterface alle ondersteunde CQL-vergelijkingen kan genereren.
[informations renvoyées]
[teruggestuurde informatie]
Permet de décider quelles informations doivent être présentes dans les résultats. Ces informations sont identifiées via des abréviations (cf. table ci-dessous reprenant les principaux) séparées par des ",". Pour de meilleurs performances, il est conseillé de limiter les informations à celles nécessaires à l'usage prévu des résultats de recherche. L'ensemble des informations liées à un spectacle sont accessibles via l'API Scapin dédiée (voir ci-dessous).
Bepaalt welke informatie moet worden weergegeven in de resultaten. Deze informatie wordt geïdentificeerd aan de hand van afkortingen (zie onderstaande tabel met een overzicht van de belangrijkste afkortingen), gescheiden door ",". Voor de beste prestaties is het aan te raden de informatie te beperken tot het strikt noodzakelijke voor het beoogde gebruik van de zoekresultaten. Alle informatie over voorstellingen is toegankelijk via de specifieke SCAPIN API (zie verder).
[tri]
[sorteren]
Permet de décider sur quelle information sont triés les résultats. Tri croissant uniquement sur une seule information, via son abréviation. Ce paramètre est sans effet si l'information choisie pour le tri n'est pas présente dans les informations renvoyées.
Bepaalt op basis van welke informatie de resultaten worden gesorteerd. Het sorteren is opgaand en wordt uitgevoerd op basis van één informatiecriterium, via de afkortingen. Deze parameter heeft geen effect als de geselecteerde informatie voor het sorteren niet aanwezig is in de teruggestuurde informatie.
[page de résultats]
[resultatenpagina]
Facultatif ; défaut : 1.
Optioneel; standaard: 1.
[nb de résultats par page]
[aantal resultaten per pagina]
Facultatif ; défaut : 1000 ; max. : 1000.
Optioneel; standaard: 1000; maximum: 1000.
Exemples
Voorbeelden
https://api.aml-cfwb.be/cql/sru.svc/anon/get?db=scapin.s&format=json&q=(pelléas national)&sortBy=s.a&resultFields=s.a,t,p.d :
renvoie tous les spectacles qui contiennent les mots "pelléas" et "national" dans leur description
stuurt alle voorstellingen terug die de woorden "Pelléas" en "national" in hun beschrijving bevatten.
https://api.aml-cfwb.be/cql/sru.svc/anon/get?db=scapin.s&format=json&q=(t=roméo*)&sortBy=s.a&resultFields=s.a,t,p.d :
renvoie tous les spectacles dont le titre commence par "roméo"
stuurt alle voorstellingen terug waarvan de titel begint met "roméo".
https://api.aml-cfwb.be/cql/sru.svc/anon/get?db=scapin.s&format=json&q=(p.d=Théâtre Royal du Parc) AND (s.a=2022-2023)&sortBy=s.a&resultFields=s.a,t,p.d :
renvoie tous les spectacles produits par le Théâtre Royal du Parc durant la saison 2022-2023
stuurt alle voorstellingen terug die door het Théâtre Royal du Parc zijn geproduceerd in het seizoen 2022-2023.
Sans Request Header, réponse limitée à 10 résultats. Zonder request header, antwoord beperkt tot 10 resultaten.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting | Abréviation Afkorting |
|---|---|---|---|
| ID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer van voorstelling; max. 2^63 | id |
| Texte1 | string | Titre ; max. 255 ca Titel; max. 255 tekens | t |
| Texte2 | string | Producteurs, séparés par " - ", triés par implication (principal, secondaire, soutien) Producenten, gescheiden door " - ", gesorteerd op betrokkenheid (primair, secundair, ondersteunend) | p.d |
| Texte3 | string | Membres créatifs, format "Fonction: Prénom Nom", séparés par " - ", triés par fonction (auteur, d'après, conception, traduction, adaptation, écriture, mise en scène, mise en voix, scénographie, chorégraphie, compositeur) Creatieve medewerkers, formaat “functie: voornaam naam”, gescheiden door " - ", gesorteerd op functie (auteur, naar het werk van, naar het idee van, vertaling, bewerking, geschreven door, ingesproken door, regie, scenografie, choreografie en compositie) | e.cr |
| Texte4 | string | Saison ; format AAAA-AAAA Seizoen; formaat JJJJ-JJJJ | s.a |
| Texte5 | string | Nombre de représentations total, toutes saisons confondues Totaal aantal voorstellingen, alle seizoenen samen | r.nbt |
| Texte6 | string | Saison de la dernière reprise du spectacle ; format AAAA-AAAA Seizoen laatste opvoering; formaat JJJJ-JJJJ | s.der |
| Texte10 | string | Date première ; format AAAA/MM/JJ ; première représentation toutes saisons confondues Datum première; formaat JJJJ/MM/DD; eerste opvoering alle seizoenen samen | d.p |
| Texte11 | string | Date reprise ; format AAAA/MM/JJ ; première représentation pour la saison en cours Datum heropvoering; formaat JJJJ/MM/DD; eerste opvoering huidig seizoen | d.r |
| Texte13 | string | Nombre de représentations durant la saison Aantal voorstellingen in seizoen | r.nbs |
| Texte14 | string | Cote de rangement de l'affiche du spectacle ; le {sigle} est propre à chaque partenaire Referentienummer van affiche van voorstelling; de {afkorting} is eigen aan elke partner | wap.{sigle} |
| Texte24 | string | Cote de rangement des photos du spectacle ; si plusieurs cotes, séparées par "|" Referentienummer van foto’s van voorstelling; indien verschillende referentienummers, gescheiden door “ | ” | web.pho |
Recherche des valeurs distinctes Zoeken op afzonderlijke waarden
Requête Verzoek
Structure de la requête :
https://api.aml-cfwb.be/cql/sru.svc/anon/getdistinct?db=scapin.s&q=[requête CQL]&field=[information visée]
https://api.aml-cfwb.be/cql/sru.svc/anon/getdistinct?db=scapin.s&q=[CQL-verzoek]&field=[beoogde informatie]
[requête CQL]
[CQL-verzoek]
Requête selon l'implémentation CQL de Scapin, qui permet, via le protocole SRU, des recherches simples "plein texte", mais aussi multi-critères combinatoires (avec opérateurs AND, OR, NOT, PROX). Les partenaires référencés de SCAPIN ont accès à Phormion, dont l'interface de recherche permet de générer toutes les équations CQL supportées.
Verzoek volgens de CQL-implementatie van SCAPIN, die via het SRU-protocol zowel eenvoudige full text-zoekopdrachten als complexe zoekopdrachten op basis van verschillende criteria (met de operatoren AND, OR, NOT en PROX) mogelijk maakt. Geregistreerde partners bij SCAPIN hebben toegang tot Phormion, waarvan de zoekinterface alle ondersteunde CQL-vergelijkingen kan genereren.
[information visée]
[beoogde informatie]
Information dont sont attendues les valeurs distinctes dans les résultats de la requête. L'information est identifiée par son abréviation.
Informatie waarvan afzonderlijke waarden worden verwacht in de zoekresultaten, geïdentificeerd door zijn afkorting.
Exemple
Voorbeeld
https://api.aml-cfwb.be/cql/sru.svc/anon/getdistinct?db=scapin.s&q=(p.d=Théâtre du Papyrus)&field=s.a :
renvoie les saisons distinctes durant lesquelles le Théâtre du Papyrus a produit des spectacles
stuurt de afzonderlijke seizoenen terug waarin het Théâtre du Papyrus voorstellingen heeft geproduceerd
Sans Request Header, réponse vide. Zonder request header, leeg antwoord.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| Field | string | Valeur distincte de l'information choisie. Afzonderlijke waarde van gekozen informatie |
| DistinctCount | int | Nombre d'occurrences de la valeur distincte parmi les résultats de la requête CQL. Aantal keren dat afzonderlijke waarde voorkomt in resultaten van CQL-verzoek |
3. API SCAPIN 3. SCAPIN API
Informations générales Algemene informatie
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/get/[IDspectacle]
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/get/[voorstelling-ID]
[IDspectacle]
[voorstelling-ID]
L'identifiant unique du spectacle, généralement obtenu après une requête.
Uniek identificatienummer van de voorstelling, meestal verkregen na een verzoek.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| ID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer van voorstelling; max. 2^63 tekens |
| Titre | string | Max. 255 ca Max. 255 tekens |
| ComplementTitre | string | Nb de ca illimité Oneindig aantal tekens |
| CommentairesResume | string | Nb de ca illimité Oneindig aantal tekens |
| Saison | string | Format AAAA-AAAA Formaat JJJJ-JJJJ |
| Aides | string | Nb de ca illimité Oneindig aantal tekens |
| Notes | string | Nb de ca illimité Oneindig aantal tekens |
| LieuPremiere | string | Max. 255 ca Max. 255 tekens |
| DatePremiere | string | Format AAAA/MM/JJ Formaat JJJJ/MM/DD |
| LieuReprise | string | Max. 255 ca Max. 255 tekens |
| DateReprise | string | Format AAAA/MM/JJ Formaat JJJJ/MM/DD |
| NotesCachees | string | Nb de ca illimité Oneindig aantal tekens |
| Duree | string | Nb de ca illimité Oneindig aantal tekens |
| Tags | string | Tags, séparés par " - " Tags, gescheiden door " - " |
| SerieID | int | Si > 0, identifiant unique de la série à laquelle appartient le spectacle ; max. 2^63 Indien > 0, uniek identificatienummer van reeks waartoe voorstelling behoort; max. 2^63 tekens |
Equipe Team
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
ttps://api.aml-cfwb.be/scapin/spectacle.svc/anon/getequipe/[IDspectacle]
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/getequipe/[voorstelling-ID]
[IDspectacle]
[voorstelling-ID]
L'identifiant unique du spectacle, généralement obtenu après une requête.
Uniek identificatienummer van de voorstelling, meestal verkregen na een verzoek.
Sans Request Header, réponse limitée à 5 membres. Zonder request header, antwoord beperkt tot 5 leden.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| ID | int | Identifiant unique de la ligne ; max. 2^63 Uniek identificatienummer link persoon/voorstelling; max. 2^63 |
| TempSpectaclesID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer voorstelling; max. 2^63 |
| Classement | int | Max. 2^15 ; défaut : 0 Max. 2^15 ; standaard: 0 |
| NomPrenom | string | Format "Nom, Prénom" ; max. 512 ca Formaat "naam, voornaam"; max. 512 tekens |
| Nom | string | Max. 255ca Max. 255 tekens |
| Prenom | string | Max. 255ca Max. 255 tekens |
| MembreEquipeID | int | Max. 2^63 |
| ISNI | string | 16ca tekens ; International Standard Name Identifier |
| MentionLibre | string | Max. 255ca Max. 255 tekens |
| Fonction | string | Max. 255ca Max. 255 tekens |
| FonctionNL | string | Max. 255ca Max. 255 tekens |
| FonctionID | int | Max. 2^31 |
| FonctionLibre | string | Max. 255ca Max. 255 tekens |
| Interprete | bool | 1 si sur scène ; 0 pour toutes les autres fonctions 1 indien op podium; 0 voor alle andere functies |
| Notes | string | Nb de ca illimité Oneindig aantal tekens |
| RoleDansSpectacle | string | Max. 255ca Max. 255 tekens |
| RolePartage | int | Max. 255 ; défaut : 0 ; identique pour tous les membres qui ont partagé le même rôle Max. 255 ; standaard: 0; identiek voor alle leden die dezelfde rol delen |
Producteurs Producenten
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/getproduction/[IDspectacle]
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/getproduction/[voorstelling-ID]
[IDspectacle]
[voorstelling-ID]
L'identifiant unique du spectacle, généralement obtenu après une requête.
Uniek identificatienummer van de voorstelling, meestal verkregen na een verzoek.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| ID | int | Identifiant unique de la ligne ; max. 2^63 Uniek identificatienummer link producent/voorstelling; max. 2^63 |
| TempSpectaclesID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer voorstelling; max. 2^63 |
| DenominationOrganisme | string | Max. 255ca Max. 255 tekens |
| OrganismeID | int | Max. 2^63 |
| Implication | int | 0 : principal ; 1 : secondaire ; 2 : soutien 0: primair; 1: secundair; 2: ondersteunend |
| Notes | string | Nb de ca illimité Oneindig aantal tekens |
Documents Documenten
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/getdocs/[IDspectacle]?withUrl=[avec url]&withSerie=[avec liens sériels]
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/getdocs/[voorstelling-ID]?withUrl=[met URL]&withSerie=[met link reeksen]
[IDspectacle]
[voorstelling-ID]
L'identifiant unique du spectacle, généralement obtenu après une requête.
Uniek identificatienummer van de voorstelling, meestal verkregen na een verzoek.
[avec url]
[met URL]
Valeur : yes/no ; facultatif ; défaut : yes. Si "yes", renvoie tous les fichiers numériques liés aux cotes ; si "no", renvoie toutes les cotes liées.
Waarde: yes/no; optioneel; standaard: yes. Als "yes", stuurt alle digitale bestanden gekoppeld aan de referentienummers terug; Als "no", stuurt alle gekoppelde referentienummers terug.
[avec liens sériels]
[met link reeksen]
Valeur : 0/1 ; facultatif ; défaut : 0. Si 1, renvoie aussi les fichiers numériques liés aux cotes liées aux spectacles de la même série (à l'exclusion des affiches).
Waarde : 0/1; optioneel; standaard: 0. Als 1, stuurt ook de digitale bestanden terug die gekoppeld zijn aan de referentienummers van de voorstellingen in dezelfde reeks (met uitzondering van de affiches).
Sans Request Header, réponse limitée à la première cote. Zonder request header, antwoord beperkt tot het eerste referentienummer
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| ID | int | Identifiant unique de la ligne ; max. 2^63 Uniek identificatienummer link document/voorstelling; max. 2^63 |
| TempSpectaclesID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer voorstelling; max. 2^63 tekens |
| Notes | string | Nb de ca illimité Oneindig aantal tekens |
| Cote | string | Max. 255ca Max. 255 tekens |
| Url | string | Url complet du fichier numérique lié Volledige URL van gekoppeld digitaal bestand |
| Extension | string | Extension du fichier numérique, avec le point Extensie van digitaal bestand, met "." |
| Support | string | Max. 50 ca ; désigne le support de la cote liée (photo, affiche, livre, vidéo...) ; si 'permalink', l'url renvoie à une page web Max. 50 tekens; duidt medium van gekoppeld materiaal aan (foto, affiche, boek, video...); 'permalink' indien URL verwijst naar webpagina. |
| IsAffiche | bool | 1 pour la cote désignée comme l'affiche principale du spectacle ; 0 pour les autres 1 voor referentienummer aangeduid als hoofdaffiche van voorstelling; 0 voor andere |
| IsImage | bool | 1 si fichier image (jpg, png...) ; 0 pour les autres 1 indien bestand een foto is (JPG, PNG…); 0 voor andere |
| AVPNom | string | Spécial vidéo : nom de la plateforme (Youtube, Viméo, DailyMotion) Enkel voor video: naam van platform (Youtube, Vimeo, DailyMotion) |
| AVPID | string | Spécial vidéo : identifiant unique de la vidéo spécifique à la plateforme Enkel voor video: uniek identificatienummer van specifieke video op platform |
Tournées Tournees
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/gettournee/[IDspectacle]
https://api.aml-cfwb.be/scapin/spectacle.svc/anon/gettournee/[voorstelling-ID]
[IDspectacle]
[voorstelling-ID]
L'identifiant unique du spectacle, généralement obtenu après une requête.
Uniek identificatienummer van de voorstelling, meestal verkregen na een verzoek.
Sans Request Header, réponse limitée à la première ligne. Zonder Request Header, antwoord beperkt tot de eerste link.
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| ID | int | Identifiant unique de la ligne ; max. 2^63 Uniek identificatienummer link locatie/voorstelling; max. 2^63 |
| TempSpectaclesID | int | Identifiant unique du spectacle ; max. 2^63 Uniek identificatienummer voorstelling; max. 2^63 |
| Rang | int | Classement de la ligne ; max. 2^15 Rangschikking van link locatie/voorstelling; max. 2^15 tekens |
| Nombre | int | Nombre de représentations pour le groupe défini par la ligne ; max. 2^15 Aantal voorstellingen voor groep gedefinieerd door link locatie/voorstelling; max. 2^15 |
| Dates | string | Texte libre, non formatté ; max. 255ca Vrije tekst, niet geformatteerd; max. 255 tekens |
| Salle | string | Max. 255ca Max. 255 tekens |
| Lieu | string | Max. 255ca Max. 255 tekens |
| Villes | string | Noms des villes en français séparés par " - " Namen van steden in Frans gescheiden door " - " |
| Pays | string | Nom du pays en français ; max. 50ca Naam van land in Frans; max. 50 tekens |
| PaysNL | string | Nom du pays en néerlandais ; max. 50ca Naam van land in Nederlands; max. 50 tekens |
| PaysISO | string | Code ISO 3166-2 du pays ISO 3166-2-code van land |
| Cadre | string | Max. 255ca Max. 255 tekens |
| Organisateurs | string | Organisateurs séparés par " - " Organisatoren gescheiden door " - " |
| Notes | string | Nb de ca illimité Oneindig aantal tekens |
4. API WEB 4. WEB API
Galerie Galerij
Requête Verzoek
Structure de la requête :
Structuur van het verzoek:
https://api.aml-cfwb.be/web/fichiers.svc/anon/getgallery?cotes=[cotes]&orientation=[orientation]&random=[aléatoire]
https://api.aml-cfwb.be/web/fichiers.svc/anon/getgallery?cotes=[referentienummers]&orientation=[stand]&random=[willekeurig]
[cotes]
[referentienummers]
Les cotes de classement des fichiers désirés.
De referentienummers van de gewenste documenten.
[orientation]
[stand]
Permet de filtrer les images par orientation ; deux valeurs possibles : "paysage" ou "portrait".
Filtert foto’s op basis van stand; twee mogelijke waarden: "paysage" of "portrait".
[aléatoire]
[willekeurig]
Ne sélectionne qu'un fichier aléatoirement par cote ; deux valeurs possibles : "yes" ou "no" ; défaut : "no".
Selecteert slechts één willekeurig bestand per referentienummer; twee mogelijke waarden: "yes" of "no"; standaard: "no".
Réponse Antwoord
| Intitulé Titel | Type Type | Commentaire Toelichting |
|---|---|---|
| path_display | string | Chemin local du fichier Lokaal pad van bestand |
| name | string | Nom du fichier, avec extension Naam van bestand, met extensie |
| size | int | Poids du fichier, en ko Grootte van bestand, in kB |
| client_modified | string | Date de dernière modification du fichier, au format DTZ Datum van laatste aanpassing van bestand, in DTZ-formaat |
| url | string | Url publique complète du fichier Volledige, publieke URL van bestand |
| cote | string | Cote de classement du fichier Referentienummer van bestand |
| extension | string | Extension du fichier, avec le "." Extensie van bestand, met "." |
| isImage | bool | 1 si le fichier est une image ; 0 dans le cas contraire 1 indien bestand een foto is; 0 voor andere |
| orientation | string | Seulement pour les fichiers "image" : orientation paysage ou portrait Enkel voor fotobestanden ("image"): landschap of portret |
| width | int | Seulement pour les fichiers "image" : largeur en pixel Enkel voor fotobestanden ("image"): breedte in pixel |
| height | int | Seulement pour les fichiers "image" : hauteur en pixel Enkel voor fotobestanden ("image"): hoogte in pixel |