API Judging Scores - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:12Z

Remove username/password API auth; ApiKey only

Trent: Document score upload and JudgingScoresForRound get

2026-07-25T18:49:49Z

Document score upload and JudgingScoresForRound get

Peter at 03:55, 11 April 2024

2024-04-11T03:55:25Z

Michael at 21:08, 3 November 2021

2021-11-03T21:08:47Z

Trent at 23:16, 14 June 2021

2021-06-14T23:16:33Z

Trent: /* Judging Scores */

2021-06-14T23:14:37Z

Judging Scores

Trent at 23:13, 14 June 2021

2021-06-14T23:13:54Z

Trent: Created page with "== Judging Scores == You can use our api to access your judges scores for a given round. To do this you need to POST a message to your site. Below is an example of what needs..."

2021-06-14T23:12:23Z

Created page with "== Judging Scores == You can use our api to access your judges scores for a given round. To do this you need to POST a message to your site. Below is an example of what needs..."

New page

== Judging Scores ==
You can use our api to access your judges scores for a given round. To do this you need to POST a message to your site. Below is an example of what needs to be posted. You can get round Id from the get info api call, judge id, and project key are returned when a judge or project is added.

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/JudgingScores', {
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: {
RoundId: 1,
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

@@ Line 12: / Line 12: @@
 ! 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 21: / Line 19: @@
 |}
 Calls must be run '''server-side''' — do not expose your API key in a browser.

@@ Line 1: / Line 1: @@
 == Judging Scores ==
-You can use our api to access your judges scores for a given round. To do this you need to POST a message to your site. Below is an example of what needs to be posted. You can get round Id from the get info api call, judge id, and project key are returned when a judge or project is added.
+Two related endpoints:
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/JudgingScoresForRound', {
      method:'POST',
@@ Line 9: / Line 47: @@
      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',
              Body: {
-				RoundId: 1, // see below on how to get round Id
+				RoundId: 2,
+				ClearOldScores: false  // WARNING: if true this CLEARS scores before reading
          })
 })
@@ Line 18: / Line 57: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
 </syntaxhighlight>
-You can get round info by calling our get info api. [[API Get Info]]
+=== Field notes ===
+* Round ids come from [[API Get Info]] → <code>Rounds</code>.
-<br/><br/><br/><br/>
+<br/><br/>
 [[Category: API]]

← Older revision		Revision as of 21:08, 3 November 2021
Line 23:		Line 23:

	You can get round info by calling our get info api. [[API Get Info]]		You can get round info by calling our get info api. [[API Get Info]]
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]

@@ Line 12: / Line 12: @@
              FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
              Body: {
-				RoundId: 1, // [[API Get Info|Get Round Id]]
+				RoundId: 1, // see below on how to get round Id
+             }
          })
@@ Line 21: / Line 21: @@
 </syntaxhighlight>