API Set Judging Assignments - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:15Z

Remove username/password API auth; ApiKey only

Trent: Document judging assignment upload

2026-07-25T18:49:47Z

Document judging assignment upload

Peter at 03:56, 11 April 2024

2024-04-11T03:56:58Z

Trent at 17:38, 1 February 2023

2023-02-01T17:38:35Z

Michael at 21:13, 3 November 2021

2021-11-03T21:13:46Z

Trent: /* Upload loading Judging Assignments */

2021-06-11T21:26:00Z

Upload loading Judging Assignments

Trent: Created page with "== Upload loading Judging Assignments == You can use our api to upload your judging assignments. To do this you need to POST a message to your site. Below is an example of wha..."

2020-12-12T22:12:52Z

Created page with "== Upload loading Judging Assignments == You can use our api to upload your judging assignments. To do this you need to POST a message to your site. Below is an example of wha..."

New page

== Upload loading Judging Assignments ==
You can use our api to upload your judging assignments. 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/JudgingAssignments', {
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: 123,
Assignments:[{
ProjectKey: 'e381c719-d7fc-471a-b50c-fe51747652e4',
JudgeId: '674907d1-60db-443b-b3c9-4755564c94a9',
At: '2020-12-31 11:30 am', //optional
},
...
]
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

* Note that all all assignments in this round will be cleared, prior to setting these new assignments.

@@ 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: @@
-== Upload loading Judging Assignments ==
+== Set Judging Assignments ==
-You can use our api to upload your judging assignments. 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.
+Creates judge-to-project assignments for a judging round. Optionally clears existing assignments for that round first.
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/JudgingAssignments', {
      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: {
-			RoundId: 123,
+				RoundId: 2,                 // required — from Get Info Rounds
-			Assignments:[{
+				ClearOldAssignments: true,  // default true
-				ProjectKey: 'e381c719-d7fc-471a-b50c-fe51747652e4',
+				ClearOldScores: true,       // accepted on the model; assignments use ClearOldAssignments
-				JudgeId: '674907d1-60db-443b-b3c9-4755564c94a9',
+				Assignments: [
-				At: '2020-12-31 11:30 am', //optional
-			},...],
+						ProjectKey: "32161f13-474b-442f-ac1f-edca7348e000",
-			ClearOldAssignments:false, //(true or false) Optional, default is true
+						JudgeId: "judge-public-guid",  // from Get Judges → id
-			...
+						At: "2024-03-15T15:30:00Z"     // optional interview time
-−
+					}
          })
 })
@@ Line 25: / Line 59: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
-</syntaxhighlight>
+Invalid round example:
-<br/><br/><br/><br/>
+<br/><br/>
 [[Category: API]]

← Older revision		Revision as of 21:13, 3 November 2021
Line 31:		Line 31:

	* Note that all all assignments in this round will be cleared, prior to setting these new assignments.		* Note that all all assignments in this round will be cleared, prior to setting these new assignments.
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]