Onglet Détails - Paramètres

Dans cette section, vous trouverez tous les types de paramètres qui peuvent être utilisés pour faire l’appel de l’API.

Paramètres d’en-tête (Header Parameters):

Les paramètres d'en-tête sont utilisés pour les en-têtes HTTP personnalisés. On y retrouve entre autres la clé d'API (X-IMB-Client-Id).

Contrairement aux paramètres de requête et de chemin, les paramètres d'en-tête n'apparaissent pas dans l'URL de la demande.

L’autorisation: le jeton d’accès et la clé d’API (X-IMB-Client-Id) (obligatoire)
Les paramètres spécifiques à une API, par exemple IdTransporteurScolaireApi pour l’API Circuits du produit Gestion de transport
Content-Type: application/json (optionnel)
Cache-Control (optionnel)
Accept: application/json (optionnel)

Paramètres du chemin (Path Parameters) :

Les paramètres de chemin font partie du point de terminaison et sont obligatoires.

Ce type de paramètre est utilisé pour cibler une ressource spécifique, par exemple l’identifiant d’un employé.

Il est représenté entre accolades {idEmploye}. Il se trouve avant le « ? ».

L’ordre d’exécution de ce paramètre est important.

Onglet Détails - Parametres - Chemin

Exemple:

https://gateway.api.grics.ca/v2/{idOrganisationScolaire}/employes/{idEmploye}
https://gateway.api.grics.ca/v2/999999/employes/idEmploye=000000001

Paramètres de la requête (Query Parameters):

Les paramètres de requête apparaissent après un point d'interrogation (?) dans le point de terminaison.
Certains paramètres sont obligatoires, d’autres facultatifs.
Ils font office de filtre.

Chaque paramètre est répertorié l'un après l'autre avec une éperluette (&) les séparant.
L'ordre des paramètres n'a pas d'importance.

Onglet Détails - Parametres - Requête

Exemple:

https://gateway.api.grics.ca/v2/{idOrganisationScolaire}/employes?{courrielProfessionnel}
https://gateway.api.grics.ca/v2/999999/employes?courrielProfessionnel=daphne.cartier@domaine.ca

Paramètres du corps du message (Request Body):

Ce sont les données envoyées à l'API.
Les routes d'API utilisant les méthodes POST, PUT et PATCH doivent spécifier les données à créer/modifier.
Ces données sont passées au format JSON dans les paramètres du corps du message.

Onglet Détails - Parametres - Corps

Exemple de contenu JSON pour le corps du message pour le POST de l'API Admission d'un élève:

{
  "idEcole": "011",
  "ordreEnseignement": "primaire",
  "dateDebut": "2023-08-29",
  "eleve": {
    "nom": "Robin",
    "prenom": "Jeannette",
    "prenomLegal": "Jeannette",
    "sexe": "feminin",
    "sexeLegal": "feminin",
    "dateNaissance": "2010-02-15",
    "lieuNaissance": {
      "pays": "Québec",
      "ville": "Montréal"
    },
    "langueMaternelle": "Français",
    "langueParlee": "Français",
    "parent1": {
      "nom": "Haddock",
      "prenom": "Jean",
      "sexe": "masculin",
      "dateNaissance": "1969-02-15",
      "paysNaissance": "Québec",
      "telephonesPersonnels": [
        {
          "numero": "5145555555",
          "typeTelephone": "telephone"
        },
		{
		  "numero": "5146666666",
          "typeTelephone": "mobile"
		}
      ],
      "telephonesProfessionnels": [
        {
          "numero": "5147777777",
          "poste": "2452",
          "typeTelephone": "telephone"
        },
        {
          "numero": "4387777777",
          "poste": "2452",
          "typeTelephone": "telephone"
        }
      ],
      "courriel": "jeanpaul@gmail.com",
      "adresse": {
        "envoiMEQ": "true",
        "numeroMunicipal": "5100",
        "typeRue": "RU",
        "rue": "Sherbrooke",
        "orientationRue": "E",
        "appartement": "3",
        "ville": "Montréal",
        "codePostal": "H1V3R9",
        "province": "QC",
        "pays": "Canada"
      },
      "repondant": "false"
    },
    "parent2": {
      "nom": "Robin",
      "prenom": "Simonne",
      "sexe": "feminin",
      "dateNaissance": "1965-04-15",
      "paysNaissance": "Québec",
      "telephonesPersonnels": [
        {
          "numero": "5145555555",
          "typeTelephone": "telephone"
        },
		{
		  "numero": "4502222222",
		  "typeTelephone": "mobile"
		}
      ],
      "telephonesProfessionnels": [
        {
          "numero": "5147777777",
          "poste": "2452",
          "typeTelephone": "telephone"
        },
        {
          "numero": "4387777777",
          "poste": "2452",
          "typeTelephone": "telephone"
        }
      ],
      "courriel": "simonne@gmail.com",
      "adresse": {
        "envoiMEQ": "true",
        "numeroMunicipal": "5100",
        "typeRue": "RU",
        "rue": "Sherbrooke",
        "orientationRue": "E",
        "appartement": "3",
        "ville": "Montréal",
        "codePostal": "H1V3R9",
        "province": "QC",
        "pays": "Canada"
      },
      "repondant": "true"
    },
        "contactUrgence": {
            "nom": "contactUrgence",
            "telephones": [
                {
                    "numero": "5149119111",
                    "typeTelephone": "telephone",
                    "poste": "4422"
                }
            ]
        }
    }
}

Table of Contents

Onglet Détails - Paramètres