API Get Schools - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:09Z

Remove username/password API auth; ApiKey only

Trent: Document schools list response and includePreloadedSchools

2026-07-25T18:49:37Z

Document schools list response and includePreloadedSchools

Trent at 21:29, 16 August 2024

2024-08-16T21:29:14Z

Trent at 21:28, 16 August 2024

2024-08-16T21:28:11Z

Peter at 03:52, 11 April 2024

2024-04-11T03:52:39Z

Michael at 21:09, 3 November 2021

2021-11-03T21:09:38Z

Trent: Created page with "== Get Schools == Get a list of schools from our API. fetch('/api/data/schools', { method:'POST', headers:{'Content-Type': '..."

2021-06-15T21:03:52Z

Created page with "== Get Schools == Get a list of schools from our API. <syntaxhighlight lang="JavaScript" line> fetch('/api/data/schools', { method:'POST', headers:{'Content-Type': '..."

New page

== Get Schools ==
Get a list of schools from our API.

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/schools', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
Body: {}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

@@ Line 9: / Line 9: @@
 ! Field !! Required !! Description
 |-
-| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+| <code>ApiKey</code> || Yes || Private API key for your site.
 |-
 | <code>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
@@ Line 18: / Line 16: @@
 |}
 Calls must be run '''server-side''' — do not expose your API key in a browser.

@@ Line 1: / Line 1: @@
 == Get Schools ==
-Get a list of schools from our API.
+Returns schools for the client associated with the fair. Optionally include preloaded/system schools.
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/schools', {
      method:'POST',
@@ Line 9: / Line 41: @@
      body: JSON.stringify({
              ApiKey:'<Private key>',
-             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
+             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
              Body: {
-                includePreloadedSchools: false, //true or false, This field is optional.
+				includePreloadedSchools: false  // optional, default false
-−
+			}
          })
 })
@@ Line 18: / Line 50: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
 </syntaxhighlight>
-Notes:
+=== Field notes ===
-*includePreloadedSchools - when true it will return preloaded schools if enabled on your event.
+* Set <code>Body.includePreloadedSchools</code> to <code>true</code> to include preloaded schools in addition to client schools.
-<br/><br/><br/><br/>
+<br/><br/>
 [[Category: API]]

@@ Line 11: / Line 11: @@
              FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
              Body: {
-                 includePreloadedSchools: false, //true or false, This field is optional, when true it will return preloaded schools if enabled on your event.
+                 includePreloadedSchools: false, //true or false, This field is optional.
+             }
          })
@@ Line 22: / Line 22: @@
 <br/><br/><br/><br/>
 [[Category: API]]

← Older revision		Revision as of 21:09, 3 November 2021
Line 19:		Line 19:

	</syntaxhighlight>		</syntaxhighlight>
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]

@@ Line 8: / Line 8: @@
      headers:{'Content-Type': 'application/json'},
      body: JSON.stringify({
-             Username:'admin username',
+             ApiKey:'<Private key>',
              FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
              Body: {}