API Add School - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:05Z

Remove username/password API auth; ApiKey only

Trent: Document add/update school fields

2026-07-25T18:49:41Z

Document add/update school fields

Peter at 03:49, 11 April 2024

2024-04-11T03:49:43Z

Michael at 21:06, 3 November 2021

2021-11-03T21:06:41Z

Trent at 22:26, 1 September 2020

2020-09-01T22:26:29Z

Trent at 22:17, 31 August 2020

2020-08-31T22:17:41Z

Trent at 22:45, 28 August 2020

2020-08-28T22:45:04Z

Trent at 22:39, 28 August 2020

2020-08-28T22:39:37Z

Trent at 22:38, 28 August 2020

2020-08-28T22:38:24Z

Trent at 22:37, 28 August 2020

2020-08-28T22:37:35Z

@@ 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: @@
-== Add Schools ==
+== Add School ==
-You can use our api to add schools to your contest. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
+Creates or updates a school on the client. If <code>Id</code> is set to an existing school id, the school is updated; otherwise a new school is created.
- fetch('/api/data/school', {
+=== Authentication ===
- 	method:'POST',
+All data API calls are <code>POST</code> (unless noted) with JSON body:
-<br/><br/><br/><br/>
+Calls must be run '''server-side''' — do not expose your API key in a browser.
 [[Category: API]]

@@ Line 6: / Line 6: @@
   	headers:{'Content-Type': 'application/json'},
   	body: JSON.stringify({
-  		Username:'admin username',
+  		ApiKey:'<Private key>',
   		Body: {
   			Name: '_ A Test School'

@@ Line 2: / Line 2: @@
 You can use our api to add schools to your contest. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
-<syntaxhighlight lang="JavaScript" line>
+ fetch('/api/data/school', {
-</syntaxhighlight>

@@ Line 12: / Line 12: @@
              Body: {
                  Name: '_ A Test School'
-                 ,Address: '1219 34th State'
+                 ,Address: '1219 34th State' //optional
-                 ,Address2: 'Apt 3'
+                 ,Address2: 'Apt 3'          //optional
-                 ,City: 'Ogden'
+                 ,City: 'Ogden'              //optional
-                 ,State: 'Ut'
+                 ,State: 'Ut'                //optional
-                 ,Zip: '84403'
+                 ,Zip: '84403'               //optional
-                 ,County: 'Weber'
+                 ,County: 'Weber'            //optional
-                 ,Phone: '801-252-0903'
+                 ,Phone: '801-252-0903'      //optional
-                 ,WebsiteUrl: 'zfairs.com'
+                 ,WebsiteUrl: 'zfairs.com'   //optional
-                 ,SchoolType: 'Public' //{ Public, Private, Charter, Home}
+                 ,SchoolType: 'Public'       //{ Public, Private, Charter, Home}  //optional
-                 ,PrincipalName: 'Mrs Bell'
+                 ,PrincipalName: 'Mrs Bell'                 //optional
-                 ,PrincipalPhone: '801-252-0000'
+                 ,PrincipalPhone: '801-252-0000'            //optional
-                 ,PrincipalEmail: 'MrsBell@zfairs.com'
+                 ,PrincipalEmail: 'MrsBell@zfairs.com'      //optional
-                 ,ContactFirstName: 'Joe'
+                 ,ContactFirstName: 'Joe'                   //optional
-                 ,ContactLastName: 'Homes'
+                 ,ContactLastName: 'Homes'                  //optional
-                 ,ContactPhone: '801-252-0001'
+                 ,ContactPhone: '801-252-0001'              //optional
-                 ,ContactEmail: 'jh@zfairs.com'
+                 ,ContactEmail: 'jh@zfairs.com'             //optional
-                 ,GradeLow: '0' //pre-k = -1, k = 0
+                 ,GradeLow: '0'                             //pre-k = -1, k = 0         //optional
-                 ,GradeHigh: '12'
+                 ,GradeHigh: '12'                           //optional
-                 ,Fax: '801-252-0003'
+                 ,Fax: '801-252-0003'                       //optional
-                 ,SchoolPaysFees: false, // optional values are true/false
+                 ,SchoolPaysFees: false,                    //optional values are true/false
-                 ,Id: 1234 //optional id of school, this will trigger an updated of that school
+                 ,Id: 1234                                  //optional id of school, this will trigger an updated of that school
+             }
          })

← Older revision		Revision as of 22:39, 28 August 2020
Line 1:		Line 1:
−		+	== Add Schools ==
		+	You can use our api to add schools to your contest. To do this you need to POST a message to our site. Below is an example of what needs to be posted.

	<syntaxhighlight lang="JavaScript" line>		<syntaxhighlight lang="JavaScript" line>