Schools
StableÉ.-U. 🇺🇸 et Canada 🇨🇦
Description
Les écoles à proximité d'un emplacement au Canada et aux États-Unis sont accessibles via le point de terminaison Écoles de Local Logic, documenté ci-dessous. Les écoles sont toujours retournées par ordre croissant de linear_distance par rapport aux lat/lng précisées.
De plus, les données sur les écoles sont disponibles sous forme de fichier plat au Canada et aux États-Unis pour les clients qui préfèrent ce mode de livraison au point de terminaison API.
Les écoles comprennent des renseignements de base comme les adresses et les coordonnées, ainsi que des caractéristiques scolaires qui varient selon le pays, comme les niveaux scolaires, les langues et les programmes spéciaux. Elles comprennent également des zones de desserte, soit des polygones autour de l'école indiquant quels emplacements résidentiels sont zonés pour cette école en particulier. Aux fins de la réponse, les écoles intermédiaires sont retournées à la fois comme écoles primaires et secondaires.
Dictionnaire de données
Le tableau suivant contient les champs de la charge utile et décrit leur signification ainsi que leurs valeurs possibles.
- Canada 🇨🇦
- USA 🇺🇸
| champ | description | valeurs | format |
|---|---|---|---|
name | Le nom de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
address | L'adresse municipale de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
city | La ville de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
province | Le code postal de la province de l'école. | Chaîne de 2 caractères | Chaîne |
postalcode | Le code postal de l'école. | Chaîne de 7 caractères. | Chaîne |
country | Le nom du pays de l'école. | Canada | Chaîne |
lat | La latitude de l'école. | Une valeur numérique dans la plage [-90,90] | Nombre à virgule flottante |
lng | La longitude de l'école. | Une valeur numérique dans la plage [-180,180] | Nombre à virgule flottante |
url | Le site Web de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
school_attributes.levels | Les niveaux scolaires offerts par l'école. Cela dépend de chaque commission scolaire, mais en général, chaque niveau correspond approximativement aux échelons suivants : | preschool elementary middle secondary | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['elementary', ‘secondary’] |
school_attributes.grades | Les années scolaires offertes par l'école. | Différentes combinaisons d'échelons : PK : prématernelle JK : maternelle junior SK : maternelle senior N : pouponnière M : maternelle | Une chaîne contenant un échelon de la colonne valeurs, séparé par un tiret. Ex. : JK-8 |
school_attributes.languages | Les langues d'enseignement. | Liste non exhaustive : en : anglais fr : français cr : cri | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['en', 'fr'] |
school_attributes.programs | Les programmes offerts par l'école. | Liste non exhaustive : Chaîne de 256 caractères ou moins | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['IB', ‘Arts’] |
school_attributes.types | Le type de l'école. | publicprivate | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['public'] |
rating | Une cote alphabétique pour l'école, selon la disponibilité des données. Elle est principalement basée sur les résultats des tests provinciaux, normalisés selon le statut socioéconomique de la population étudiante. Les cotes des écoles sont disponibles seulement en Ontario et en Colombie-Britannique pour le moment, et toutes les écoles de ces provinces n'ont pas nécessairement une cote. | Valeurs de cote alphabétique, comme A, B-, C+, F | Chaîne |
school_board_attributes.name | Le nom de la commission scolaire. | Chaîne de 256 caractères ou moins | Chaîne |
school_board_attributes.url | Le site Web de la commission scolaire. | Chaîne de 256 caractères ou moins | Chaîne |
proximity.linear_distance | La distance en mètres entre l'école et les lat/lng fournies. | Entier | |
catchments.*.geometry | Un multipolygone lat/lng de la zone de desserte. | Liste | |
catchments.*.inside | Indique si les lat/lng interrogées se trouvent à l'intérieur de la zone de desserte. | Booléen | |
catchments.*.program | Le programme offert pour cette zone de desserte. | Chaîne | |
catchments.*.grade | L'année scolaire offerte pour cette zone de desserte. Consultez school_attributes.grades pour plus de renseignements. | Chaîne | |
catchments.*.level | Le niveau offert pour cette zone de desserte. Consultez school_attributes.levels pour plus de renseignements. | Chaîne |
| champ | description | valeurs | format |
|---|---|---|---|
name | Le nom de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
address | L'adresse municipale de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
city | La ville de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
province | Le code postal de l'État de l'école. | Chaîne de 2 caractères. | Chaîne |
postalcode | Le code postal de l'école. | Chaîne de 5 caractères. | Chaîne |
phone_number | Le numéro de téléphone de l'école. | Chaîne de 12 caractères au format ###-###-#### | Chaîne |
country | Le nom du pays de l'école. | United States | Chaîne |
lat | La latitude de l'école. | Une valeur numérique dans la plage [-90,90] | Nombre à virgule flottante |
lng | La longitude de l'école. | Une valeur numérique dans la plage [-180,180] | Nombre à virgule flottante |
url | Le site Web de l'école. | Chaîne de 256 caractères ou moins | Chaîne |
school_attributes.levels | Les niveaux scolaires offerts par l'école. Cela dépend de chaque commission scolaire, mais en général, chaque niveau correspond approximativement aux échelons suivants : | preschool elementary middle secondary | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['elementary', ‘secondary’] |
school_attributes.grades | Les années scolaires offertes par l'école. | Différentes combinaisons d'échelons : PK : prématernelle EE : éducation précoce TKG : maternelle transitoire | Une chaîne contenant un échelon de la colonne valeurs, séparé par un tiret. Ex. : PK-5, KG-12 |
school_attributes.programs | Les programmes offerts par l'école. | Liste non exhaustive : Chaîne de 256 caractères ou moins | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['regular', ‘charter’] |
school_attributes.types | Le type de l'école. | publicprivate | Une liste de chaînes provenant de la colonne valeurs. Ex. : ['public'] |
num_female | Le nombre d'élèves de sexe féminin à l'école. Si l'information est absente, les données ne sont pas disponibles. | Supérieur ou égal à 0. | Entier |
num_male | Le nombre d'élèves de sexe masculin à l'école. Si l'information est absente, les données ne sont pas disponibles. | Supérieur ou égal à 0. | Entier |
num_free_lunch | Le nombre d'élèves inscrits au programme de repas gratuits à l'école. Si l'information est absente, les données ne sont pas disponibles. | Supérieur ou égal à 0. | Entier |
num_reduced_lunch | Le nombre d'élèves inscrits au programme de repas à prix réduit subventionné à l'école Si l'information est absente, les données ne sont pas disponibles. | Supérieur ou égal à 0. | Entier |
num_students | Le nombre total d'élèves à l'école. Si l'information est absente, les données ne sont pas disponibles. | Supérieur ou égal à 0. | Entier |
is_advanced_placement | Indique si des cours de niveau avancé (Advanced Placement) sont offerts à l'école. Si l'information est absente, les données ne sont pas disponibles. | true ou false | Booléen |
is_charter | Indique si l'école est une école à charte (charter school). Si l'information est absente, les données ne sont pas disponibles. | true ou false | Booléen |
is_magnet | Indique si l'école offre un programme à vocation particulière (magnet). Si l'information est absente, les données ne sont pas disponibles. | true ou false | Booléen |
is_title_i_eligible | Indique si l'école est admissible au financement Title I de l'EASA. Si l'information est absente, les données ne sont pas disponibles. | true ou false | Booléen |
student_teacher_ratio | Le ratio entre la population étudiante et le nombre d'enseignants à l'école. Si l'information est absente, les données ne sont pas disponibles. | Valeur décimale supérieure ou égale à 0. | Nombre à virgule flottante |
has_library | Indique si l'école dispose d'une bibliothèque. Si l'information est absente, les données ne sont pas disponibles. | true ou false | Booléen |
rating | Une cote alphabétique pour l'école, selon la disponibilité des données. Les facteurs comprennent les résultats des tests d'État, les taux de diplomation, la préparation aux études collégiales, la disponibilité des cours et la progression académique. | Valeurs de cote alphabétique, comme A, B-, C+, F | Chaîne |
school_board_attributes.name | Le nom de la commission scolaire. | Chaîne de 256 caractères ou moins | Chaîne |
school_board_attributes.url | Le site Web de la commission scolaire. | Chaîne de 256 caractères ou moins | Chaîne |
proximity.linear_distance | La distance en mètres entre l'école et les lat/lng fournies. | Entier | |
catchments.*.geometry | Un multipolygone lat/lng de la zone de desserte. | Liste | |
catchments.*.inside | Indique si les lat/lng interrogées se trouvent à l'intérieur de la zone de desserte. | Booléen | |
catchments.*.program | Le programme offert pour cette zone de desserte. | Chaîne | |
catchments.*.grade | L'année scolaire offerte pour cette zone de desserte. Consultez school_attributes.grades pour plus de renseignements. | Chaîne | |
catchments.*.level | Le niveau offert pour cette zone de desserte. Consultez school_attributes.levels pour plus de renseignements. | Chaîne |
GET /v3/schools
Jusqu'à 30 écoles primaires et 30 écoles secondaires dans un rayon de 25 000 mètres (25 km ou 15,53 milles) peuvent être obtenues par l'entremise de l'API.
Toutes les clés, y compris celles sous school_attributes et school_board_attributes, ne sont pas nécessairement toujours présentes. La disponibilité des clés dépend de la disponibilité des données, qui varie selon l'école et la commission scolaire.
GET /v3/schools
En-tête
Cette API utilise l'authentification par jeton JWT. Ce jeton porteur (Bearer) JWT est ce qui est utilisé pour remplir
l'en-tête Authorization ci-dessous.
Les instructions pour récupérer ce jeton se trouvent dans Premiers pas.
| En-tête | Statut | Description |
|---|---|---|
| Authorization | requis | Votre jeton porteur récupéré depuis notre API d'autorisation, ex. Bearer eyJhbGci... |
| Accept | requis | Le type de données demandé; cette API retournera application/json. |
Paramètres de requête
La région interrogée par le point de terminaison peut être définie de deux façons : (1) en précisant une coordonnée lat/lng, avec des paramètres optionnels radius/radius_unit, (2) ou en fournissant un paramètre polygon.
Lorsque vous utilisez la méthode de requête par coordonnée lat/lng sans préciser les paramètres radius/radius_unit, le point de terminaison retourne les écoles se trouvant à une distance de marche de cinq minutes de la coordonnée.
Lorsque vous incluez les paramètres radius/radius_unit, la zone circulaire résultante autour de la coordonnée lat/lng est interrogée. radius_unit peut être meter ou mile.
Lorsque vous utilisez la méthode de requête par polygon, les écoles retournées se trouvent dans la région définie par la zone du polygone. Les polygones sont précisés à l'aide du format WKT.
Le seul type accepté est POLYGON, et les trous ne sont pas pris en charge. Chaque point du polygone doit être défini comme une coordonnée lng/lat.
Limites de l'API
- La chaîne de requête du polygone est limitée à 5000 caractères.
- La distance maximale nord/sud est/ouest acceptée est de 0,5 degré.
- Le nombre maximal de géohashes de niveau 6 nord/sud est/ouest est de 1000.
attention
WKT fonctionne sur des plans x/y. Par conséquent, les coordonnées doivent être envoyées sous la forme lng/lat plutôt que lat/lng.
| Paramètre | État | Description |
|---|---|---|
| lat | optionnel | Un nombre décimal entre -90 et 90, représentant la latitude. |
| lng | optionnel | Un nombre décimal entre -180 et 180, représentant la longitude. |
| polygon | optionnel | Liste de points lng/lat 2D qui définissent un polygone 2D, à l'aide de la représentation WKT |
| radius | optionnel | Utilisé pour préciser la distance maximale (en mètres) par rapport aux lat/lng fournies. Par défaut : 5000 mètres Maximum : 25000 mètres |
| limit | optionnel | La limite d'écoles retournées. Par défaut : 30 Maximum : 30 |
| language | optionnel | Valeur de chaîne représentant le code de langue à deux lettres ISO 361-1 dans lequel retourner la charge utile, ex. frDisponible : en et frPar défaut : en* Les traductions ne sont disponibles que pour les champs suivants au Canada :
|
| include_catchments | optionnel | La valeur par défaut est false. Une valeur booléenne pour obtenir ou non la zone de desserte scolaire. Si la valeur est true, la réponse contiendra une clé catchments qui contiendra la liste des zones de desserte. Elle peut être une liste vide lorsque l'information sur les zones de desserte est indisponible, ce qui est le cas pour les écoles privées et certaines écoles publiques. La clé catchments ne sera pas définie si include_catchments est false. |
Exemples d'utilisation
- NodeJS
- Python
require('node-fetch')('https://api.locallogic.co/v3/schools?' + new URLSearchParams({
lat: 43.892958,
lng: -79.426238,
radius: 3000,
limit: 10,
include_catchments: true
}), {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Bearer eyJhbGciOiJ...'
}
})
.then(response => response.json())
.then(body => {
console.log(body)
})
.catch(error => {
console.log(error)
})
import requests
response = requests.get(
"https://api.locallogic.co/v3/schools",
headers={
"Accept": "application/json",
"Authorization": "Bearer eyJhbGciOiJ..."},
params={
"lat": 43.892958,
"lng": -79.426238,
"radius": 3000,
"limit": 10,
"include_catchments": True
}
)
print(response.json())
Exemple de réponse
{
"data": {
"primary_schools": [
{
"name": "Lauremont School ? Upper School",
"address": "500 Elgin Mills Road E.",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 5G1",
"country": "Canada",
"lat": 43.893314,
"lng": -79.426394,
"url": "http://www.tmsschool.ca/",
"proximity": {
"linear_distance": 41.05108545
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Site Based Only"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Beverley Acres Public School",
"address": "283 Neal Dr",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 3L3",
"country": "Canada",
"lat": 43.88923,
"lng": -79.42313,
"url": "http://beverleyacres.ps.yrdsb.ca/",
"proximity": {
"linear_distance": 484.08616308
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "1-8",
"languages": [
"en"
],
"programs": [
"French Immersion"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "A-"
},
{
"name": "Crosby Heights Public School",
"address": "190 Neal Drive",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 3K8",
"country": "Canada",
"lat": 43.885857,
"lng": -79.423465,
"url": "http://crosbyheights.ps.yrdsb.ca/",
"proximity": {
"linear_distance": 820.29950515
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "JK-8",
"languages": [
"en"
],
"programs": [
"English"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "B-"
},
{
"name": "H G Bernard Public School",
"address": "245 Bernard Ave",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1E1",
"country": "Canada",
"lat": 43.900067,
"lng": -79.433915,
"url": "http://hgbernard.ps.yrdsb.ca/",
"proximity": {
"linear_distance": 1001.80324804
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "JK-8",
"languages": [
"en"
],
"programs": [
"English"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "B+"
},
{
"name": "Corpus Christi Catholic Elementary School",
"address": "35 Squire Dr",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1C6",
"country": "Canada",
"lat": 43.897571,
"lng": -79.438175,
"url": "http://cci.ycdsb.ca/",
"proximity": {
"linear_distance": 1087.22191583
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "JK-8",
"languages": [
"en"
],
"programs": [
"Catholic"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Catholic District School Board",
"url": "http://www.ycdsb.ca/"
},
"num_students": 0,
"rating": "A-"
},
{
"name": "Michaelle Jean Public School",
"address": "320 Shirley Drive",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 2P1",
"country": "Canada",
"lat": 43.891127,
"lng": -79.411952,
"url": "http://michaellejean.ps.yrdsb.ca/",
"proximity": {
"linear_distance": 1165.90709355
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "JK-3",
"languages": [
"en"
],
"programs": [
"French Immersion"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "A"
},
{
"name": "Richmond Rose Public School",
"address": "160 Frank Endean Rd",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1S7",
"country": "Canada",
"lat": 43.884328,
"lng": -79.412643,
"url": "http://richmondrose.ps.yrdsb.ca/",
"proximity": {
"linear_distance": 1453.90130073
},
"school_attributes": {
"levels": [
"elementary"
],
"grades": "JK-8",
"languages": [
"en"
],
"programs": [
"English"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "B+"
},
{
"name": "Holy Trinity School",
"address": "11300 Bayview Ave",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1L4",
"country": "Canada",
"lat": 43.906942,
"lng": -79.423198,
"url": "http://www.hts.on.ca/",
"proximity": {
"linear_distance": 1572.40416093
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Century Private School",
"address": "11181 Yonge Street",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1L2",
"country": "Canada",
"lat": 43.90014,
"lng": -79.443926,
"url": "http://www.centurypscanada.com/",
"proximity": {
"linear_distance": 1629.61005209
},
"school_attributes": {
"levels": [
"elementary"
],
"programs": [
"Site Based Only"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Canadians Private School",
"address": "22 22 crosby ave",
"city": "Richmond hill",
"province": "ON",
"postalcode": "L4C 2R2",
"country": "Canada",
"lat": 43.880236,
"lng": -79.438235,
"url": "http://www.canadiansprivateschool.com/",
"proximity": {
"linear_distance": 1711.35170995
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
}
],
"high_schools": [
{
"name": "Lauremont School ? Upper School",
"address": "500 Elgin Mills Road E.",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 5G1",
"country": "Canada",
"lat": 43.893314,
"lng": -79.426394,
"url": "http://www.tmsschool.ca/",
"proximity": {
"linear_distance": 41.05108545
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Site Based Only"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Warwick Academy",
"address": "556 Edward Avenue",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 9Y5",
"country": "Canada",
"lat": 43.897645,
"lng": -79.42936,
"proximity": {
"linear_distance": 577.61348684
},
"school_attributes": {
"levels": [
"secondary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Our Lady Queen of the World Ca High School",
"address": "10475 Bayview Ave",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 3P2",
"country": "Canada",
"lat": 43.886239,
"lng": -79.417936,
"url": "http://jvh.ycdsb.ca/",
"proximity": {
"linear_distance": 1001.54453492
},
"school_attributes": {
"levels": [
"secondary"
],
"grades": "9-12",
"languages": [
"en"
],
"programs": [
"Catholic"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Catholic District School Board",
"url": "http://www.ycdsb.ca/"
},
"num_students": 0,
"rating": "B+"
},
{
"name": "Hellenic Academy of York",
"address": "10475 Bayview Avenue",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 3P2",
"country": "Canada",
"lat": 43.8865955,
"lng": -79.4169375,
"url": "http://www.hccy.ca/",
"proximity": {
"linear_distance": 1029.06353205
},
"school_attributes": {
"levels": [
"secondary"
],
"programs": [
"Site Based Only"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Toronto Trinity Collegiate",
"address": "200 Town Centre Boulevard",
"city": "Markham",
"province": "ON",
"postalcode": "L3R 8G5",
"country": "Canada",
"lat": 43.888732,
"lng": -79.441338,
"url": "http://www.torontotrinity.ca/",
"proximity": {
"linear_distance": 1301.14680041
},
"school_attributes": {
"levels": [
"secondary"
],
"programs": [
"All Year Round",
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Alpha Star High School",
"address": "10670 Yonge Street",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4C 3C9",
"country": "Canada",
"lat": 43.887522,
"lng": -79.441047,
"url": "http://www.alphahighschools.com/",
"proximity": {
"linear_distance": 1334.64252218
},
"school_attributes": {
"levels": [
"secondary"
],
"programs": [
"All Year Round",
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Richmond Hill High School",
"address": "201 Yorkland St",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1A2",
"country": "Canada",
"lat": 43.902676,
"lng": -79.44047,
"url": "http://richmondhill.hs.yrdsb.ca/",
"proximity": {
"linear_distance": 1572.36092567
},
"school_attributes": {
"levels": [
"secondary"
],
"grades": "9-12",
"languages": [
"en"
],
"programs": [
"English"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "York Region District School Board",
"url": "http://www.yrdsb.ca/"
},
"rating": "B-"
},
{
"name": "Holy Trinity School",
"address": "11300 Bayview Ave",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1L4",
"country": "Canada",
"lat": 43.906942,
"lng": -79.423198,
"url": "http://www.hts.on.ca/",
"proximity": {
"linear_distance": 1572.40416093
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Century Private School HS",
"address": "11181 Yonge Street",
"city": "Richmond Hill",
"province": "ON",
"postalcode": "L4S 1L2",
"country": "Canada",
"lat": 43.90014,
"lng": -79.443926,
"url": "http://centurypscanada.com/",
"proximity": {
"linear_distance": 1629.61005209
},
"school_attributes": {
"levels": [
"secondary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
},
{
"name": "Canadians Private School",
"address": "22 22 crosby ave",
"city": "Richmond hill",
"province": "ON",
"postalcode": "L4C 2R2",
"country": "Canada",
"lat": 43.880236,
"lng": -79.438235,
"url": "http://www.canadiansprivateschool.com/",
"proximity": {
"linear_distance": 1711.35170995
},
"school_attributes": {
"levels": [
"secondary",
"elementary"
],
"programs": [
"Online/Site Based"
],
"types": [
"private"
]
},
"school_board_attributes": {
}
}
]
},
"meta": {
"message": "Successfully called v3/schools API.",
"type": "LocalLogic.API.Success",
"statusCode": 200,
"counts": {
"primary_schools": 10,
"high_schools": 10
}
}
}
GET /v3/schools/{geog_id}
Les écoles à l'intérieur et à proximité d'une géographie Local Logic sont accessibles via le point de terminaison des écoles de Local Logic, documenté ci-dessous.
Les valeurs acceptées pour geog_id sont toutes les géographies correspondant à g10_*, g20_*, g30_*, g32_*, g35_*, g37_* et g38_* (toutes les géographies sous le niveau d'une région métropolitaine). Pour obtenir un geog_id, vous pouvez utiliser le point de terminaison Local Logic Geographies
Les écoles sont retournées par ordre croissant de linear_distance_m par rapport au centroïde calculé de la géographie.
GET /v3/schools/{geog_id}
En-tête
Cette API utilise l'authentification par jeton JWT. Ce jeton porteur (Bearer) JWT est ce qui est utilisé pour remplir
l'en-tête Authorization ci-dessous.
Les instructions pour récupérer ce jeton se trouvent dans Premiers pas.
| En-tête | Statut | Description |
|---|---|---|
| Authorization | requis | Votre jeton porteur récupéré depuis notre API d'autorisation, ex. Bearer eyJhbGci... |
| Accept | requis | Le type de données demandé; cette API retournera application/json. |
Paramètres de requête
Les données proximity.linear_distance sont fournies dans la réponse en mètres de distance par rapport au centroïde de la géographie
| Paramètre | État | Description |
|---|---|---|
| buffer | optionnel | La distance au-delà des limites de la géographie pour rechercher des écoles. Ceci est utile lorsque le consommateur de l'API souhaite effectuer une recherche au-delà des limites d'une géographie, par exemple pour trouver des écoles dans un rayon de 2 km d'un quartier. Par défaut : 0 Maximum : 10000 mètres (ou 6 milles) |
| buffer_unit | optionnel | L'unité de distance au-delà des limites de la géographie pour rechercher des POI. meter ou mile.Par défaut : meter |
| language | optionnel | Valeur de chaîne représentant le code de langue à deux lettres ISO 361-1 dans lequel retourner la charge utile, ex. fr Disponible : en et frvaleur par défaut : en* Les traductions ne sont disponibles que pour les champs suivants au Canada :
|
| include_catchments | optionnel | La valeur par défaut est false. Une valeur booléenne pour obtenir ou non la zone de desserte scolaire. Si la valeur est true, la réponse contiendra une clé catchments qui contiendra la liste des zones de desserte. Elle peut être une liste vide lorsque l'information sur les zones de desserte est indisponible, ce qui est le cas pour les écoles privées et certaines écoles publiques. La clé catchments ne sera pas définie si include_catchments est false. |
| limit | optionnel | La limite d'écoles retournées. Par défaut : 30 Maximum : 30 |
Exemples d'utilisation
- NodeJS
- Python
require('node-fetch')('https://api.locallogic.co/v3/schools/g10_f25en7xd', {
method: 'GET',
headers: {
Accept: 'application/json',
Authorization: 'Bearer eyJhbGciOiJ...'
}
})
.then(response => response.json())
.then(body => {
console.log(body)
})
.catch(error => {
console.log(error)
})
import requests
response = requests.get(
"https://api.locallogic.co/v3/schools/g10_f25en7xd",
headers={
"Accept": "application/json",
"Authorization": "Bearer eyJhbGciOiJ..."}
)
print(response.json())
Exemple de réponse
{
"data": {
"primary_schools": [
{
"name": "École Baril",
"address": "3603, rue Adam",
"city": "Montreal",
"province": "QC",
"postalcode": "H1W1Z1",
"country": "Canada",
"lat": 45.544233,
"lng": -73.541319,
"proximity": {
"linear_distance": 393.89550558
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Saint-Nom-de-Jésus",
"address": "4131, rue Adam",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V1S8",
"country": "Canada",
"lat": 45.54931,
"lng": -73.537271,
"proximity": {
"linear_distance": 397.25484873
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Saint-Jean-Baptiste-de-la-Salle",
"address": "2355, boulevard Pie IX",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V2E6",
"country": "Canada",
"lat": 45.552143,
"lng": -73.546324,
"proximity": {
"linear_distance": 599.59357222
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Maisonneuve",
"address": "1680, avenue Morgan",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V2P9",
"country": "Canada",
"lat": 45.552135,
"lng": -73.536484,
"proximity": {
"linear_distance": 642.27623557
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Notre-Dame-de-l'Assomption",
"address": "2430, rue Darling",
"city": "Montreal",
"province": "QC",
"postalcode": "H1W2X1",
"country": "Canada",
"lat": 45.543805,
"lng": -73.552204,
"proximity": {
"linear_distance": 919.99774453
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Maisonneuve",
"address": "4650, rue Ontario Est",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V1L2",
"country": "Canada",
"lat": 45.555905,
"lng": -73.537242,
"proximity": {
"linear_distance": 974.52454894
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Sainte-Jeanne-d'Arc",
"address": "3700, rue Sherbrooke Est",
"city": "Montreal",
"province": "QC",
"postalcode": "H1X1Z8",
"country": "Canada",
"lat": 45.549194,
"lng": -73.554424,
"proximity": {
"linear_distance": 994.59270588
},
"school_attributes": {
"levels": [
"elementary",
"preschool"
],
"grades": "JK-6",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
}
],
"high_schools": [
{
"name": "École Chomedey-de Maisonneuve (Chomedey-de-Maisonneuve)",
"address": "1860, avenue Morgan",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V2R2",
"country": "Canada",
"lat": 45.552611,
"lng": -73.538572,
"proximity": {
"linear_distance": 597.21570217
},
"school_attributes": {
"levels": [
"secondary"
],
"grades": "7-11",
"languages": [
"fr"
],
"programs": [
"Regular"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Irénée-Lussier (Irénée-Lussier)",
"address": "4100, rue Hochelaga",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V1B6",
"country": "Canada",
"lat": 45.552536,
"lng": -73.546628,
"proximity": {
"linear_distance": 648.95499175
},
"school_attributes": {
"levels": [
"secondary"
],
"grades": "7-11",
"languages": [
"fr"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
},
{
"name": "École Eulalie-Durocher",
"address": "2455, avenue Letourneux",
"city": "Montreal",
"province": "QC",
"postalcode": "H1V2N9",
"country": "Canada",
"lat": 45.554713,
"lng": -73.546273,
"proximity": {
"linear_distance": 846.64028241
},
"school_attributes": {
"levels": [
"secondary"
],
"grades": "7-11",
"languages": [
"fr"
],
"types": [
"public"
]
},
"school_board_attributes": {
"name": "CSS de Montréal",
"url": "http://www.cssdm.gouv.qc.ca/"
}
}
]
},
"meta": {
"message": "Successfully called v3/schools API.",
"type": "LocalLogic.API.Success",
"statusCode": 200,
"counts": {
"primary_schools": 7,
"high_schools": 3
}
}
}
Implémentations SDK
Les écoles sont utilisées par deux SDK de Local Logic :
| SDK | Description |
|---|---|
| Local Content SDK | Récupère les écoles et leurs zones de desserte pour les afficher sur la carte du SDK. |
| NeighborhoodMap SDK | Récupère les écoles à l'intérieur et à proximité du quartier. |
Codes de réponse
Lorsque vous appelez l'API de Local Logic, vous pouvez recevoir un code de réponse HTTP indiquant une erreur ou une absence de données. Ces erreurs sont expliquées ci-dessous.
En général, les codes d'erreur commençant par « 4 » sont dus à un appel d'API invalide et peuvent être corrigés de votre côté, alors que les codes d'erreur commençant par « 5 » sont dus à des erreurs de serveur (c'est-à-dire des problèmes de notre côté). Si vous recevez quelque chose qui n'est pas décrit ici, veuillez communiquer avec nous à support@locallogic.co.
204 - No Content
Ce « code d'erreur » n'en est pas un et se produit lorsque nous n'avons pas les données requises pour un emplacement précis. Par exemple, si vous envoyez une paire lat/lng pour obtenir des scores dans des régions inhabitées du nord du Canada, nous pouvons retourner une réponse 204 vide, car nous reconnaissons l'emplacement, mais nous ne calculons pas de scores dans des endroits aussi éloignés, donc il n'y a rien à retourner.
400 - BadRequest
Ce code d'erreur se produit lorsque les données saisies dans la requête sont incorrectes. Utilisez le champ detail de la réponse pour obtenir des précisions. Exemple :
{
"code": "LocalLogic.API.BadRequest",
"detail": "ValidationErrors: AroundEndpoint is invalid:\n\tinclude is invalid: \"bad_input\" is not an acceptable value: \"groceries\", \"restaurants\", \"nightlife\", \"cafes\", \"shopping\", \"daycares\", \"primary_schools\", \"high_schools\""
}
401 - Unauthorized
Ce code d'erreur se produit lorsque votre clé API ne peut pas accéder à certaines ressources ou à certains emplacements. Par exemple, certaines clés API ne peuvent accéder qu'à certains pays, états ou provinces. N'hésitez pas à communiquer avec nous pour plus d'information.
{
"code": "LocalLogic.API.Unauthorized",
"detail": "Your API KEY doesn't support this region"
}
403 - Forbidden
Ce code d'erreur se produit lorsque vous avez oublié d'inclure les identifiants de sécurité dans votre requête ou lorsque vous demandez un paramètre auquel vous n'avez pas accès.
{
"message": "Forbidden"
}
404 - NotFound
Ce code d'erreur se produit lorsque nous n'avons pas de données pour l'emplacement demandé. Par exemple, si vous envoyez une paire lat/lng pour un emplacement en Antarctique, nous retournerons cette erreur, car nous n'avons pas (encore!) de données pour l'Antarctique.
{
"code": "LocalLogic.API.NotFound",
"detail": "No Location Scores found for this location."
}
422 - Unprocessable Entity
Ce code d'erreur est retourné lorsque les bons paramètres ont été envoyés, mais que les données qu'ils contiennent ne sont pas valides. Par exemple, si vous envoyez une paire lat/lng et que la latitude est invalide (c.-à-d. hors de la plage [-90, 90]) ou que la longitude est invalide (c.-à-d. hors de la plage [-180, 180]). Le message retourné expliquera le problème précis avec vos paramètres qui les rend invalides.
{
"message": "Latitude must be within [-90, 90], Longitude must be within [-180, 180], Requires at least lat/lng pair, or geography_ids. None supplied.",
"code": "LocalLogic.API.BadRequest",
"statusCode": 422
}
429 - Too Many Requests
Ce code d'erreur peut être retourné lorsque vous devez limiter le débit de vos requêtes. À l'interne, nous établissons des limites qui dépassent toutes les limites contractuelles pouvant entraîner le retour de ce code d'erreur. Si vous avez des questions ou si vous voyez cette erreur, veuillez communiquer avec nous à support@locallogic.co.
500 - ServerError
Ce code d'erreur signifie qu'une erreur s'est produite de notre côté. N'hésitez pas à réessayer la même requête pour voir si le problème persiste. Si vous recevez beaucoup de ces erreurs, veuillez communiquer avec nous à support@locallogic.co.
{
"code": "LocalLogic.API.ServerError",
"detail": "No Location Scores found for this location."
}
502 - BadGateway
Ce code d'erreur signifie qu'une erreur provient de notre fournisseur infonuagique. N'hésitez pas à réessayer la même requête pour voir si le problème persiste.
{
"message": "Internal server error"
}