API Upload Judging Score - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:20Z

Remove username/password API auth; ApiKey only

← Older revision		Revision as of 11:55, 25 July 2026
Line 9:		Line 9:
	! Field !! Required !! Description		! 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>Username</code> / <code>Password</code> \|\| Yes* \|\| Alternate auth if not using ApiKey~~.
	\|-		\|-
	\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).		\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).
Line 18:		Line 16:
	\|}		\|}

	* Provide '''either''' <code>ApiKey</code> '''or''' <code>Username</code>+<code>Password</code>.

	Calls must be run '''server-side''' — do not expose your API key in a browser.		Calls must be run '''server-side''' — do not expose your API key in a browser.

Trent: Document score upload to JudgingScores

2026-07-25T18:49:48Z

Document score upload to JudgingScores

← Older revision		Revision as of 11:49, 25 July 2026
Line 1:		Line 1:
	== Upload Judging ~~Scores~~ ==		== Upload Judging Score ==
	~~You can use our api to upload your judges~~ scores~~. 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~~.		Records project assessment scores for a judging round. Optionally clears existing scores for that round first.

			=== Authentication ===
			All data API calls are <code>POST</code> (unless noted) with JSON body:

			{\| class="wikitable"
			\|-
			! Field !! Required !! Description
			\|-
			\| <code>ApiKey</code> \|\| Yes* \|\| Private API key for your site. Prefer this over username/password.
			\|-
			\| <code>Username</code> / <code>Password</code> \|\| Yes* \|\| Alternate auth if not using ApiKey.
			\|-
			\| <code>FairId</code> \|\| Yes \|\| Fair GUID from the site URL (<code>f</code> query parameter).
			\|-
			\| <code>Body</code> \|\| Depends \|\| Request payload. Use <code>{}</code> when no body fields are needed.
			\|}

			* Provide '''either''' <code>ApiKey</code> '''or''' <code>Username</code>+<code>Password</code>.

			Calls must be run '''server-side''' — do not expose your API key in a browser.

			=== Response envelope ===
			Most endpoints return:

			<pre>
			{
			Success: true,
			Message: null, // error text when Success is false
			Body: { ... } // endpoint-specific payload
			}
			</pre>


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

	fetch('/api/data/JudgingScores', {		fetch('/api/data/JudgingScores', {
	method:'POST',		method:'POST',
Line 9:		Line 41:
	body: JSON.stringify({		body: JSON.stringify({
	ApiKey:'<Private key>',		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: {		Body: {
	RoundId: ~~123~~,		RoundId: 2,
	Assignments:[{		ClearOldScores: true,
	ProjectKey: ~~'e381c719~~-~~d7fc~~-~~471a~~-~~b50c~~-~~fe51747652e4'~~,		Assignments: [
	JudgeId: ~~'674907d1-60db-443b~~-~~b3c9~~-~~4755564c94a9'~~,		{
	Score: 98.2,		ProjectKey: "32161f13-474b-442f-ac1f-edca7348e000",
	Notes: ~~'Your project was great!', //optional~~		JudgeId: "judge-public-guid",
	},		Score: 95.5,
	~~ClearOldScores: true, //(true or false) Optional, default is true~~		Notes: "Strong methodology"
	~~...~~		}
	]		]
	}		}
	})		})
	})		})
Line 27:		Line 59:
	.then(data=>{console.log('Success: ',data);})		.then(data=>{console.log('Success: ',data);})
	.catch((error)=>{console.log('Error: ', error);});		.catch((error)=>{console.log('Error: ', error);});
			</syntaxhighlight>

			=== Response ===
			On success:

			<pre>
			{
			Success: true,
			Message: "Assignment count: 1\n...", // processing log; unknown judge/project lines
			Body: null
			}
			</pre>

	~~</syntaxhighlight>~~

	* ~~Note that all~~ scores ~~in this~~ round ~~will be cleared~~, ~~prior~~ to ~~setting these new assignments~~.		=== Field notes ===
			* Empty scores returns: <code>No scores to set</code>.
			* Notes default to <code>Loaded by API</code> when omitted.
			* For reading scores back for a round, POST to <code>/api/data/JudgingScoresForRound</code> with <code>Body.RoundId</code> (see [[API Judging Scores]]).


			=== Related APIs ===
			* [[API Judging Scores]]
			* [[API Set Judging Assignments]]
			* [[API Get Judges]] / [[API Get Projects]] / [[API Get Info]]


	~~<br/><br/>~~<br/><br/>		<br/><br/>
	[[Category: API]]		[[Category: API]]

Peter at 03:58, 11 April 2024

2024-04-11T03:58:08Z

← Older revision		Revision as of 20:58, 10 April 2024
Line 8:		Line 8:
	headers:{'Content-Type': 'application/json'},		headers:{'Content-Type': 'application/json'},
	body: JSON.stringify({		body: JSON.stringify({
	~~Username~~:'~~admin username',~~		ApiKey:'<Private key>',
	~~Password: 'password~~',
	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', //This value can be found in your url it's the value of f
	Body: {		Body: {

Michael at 21:13, 3 November 2021

2021-11-03T21:13:55Z

← Older revision		Revision as of 14:13, 3 November 2021
Line 32:		Line 32:

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



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

Trent at 21:32, 11 June 2021

2021-06-11T21:32:10Z

← Older revision		Revision as of 14:32, 11 June 2021
Line 16:		Line 16:
	ProjectKey: 'e381c719-d7fc-471a-b50c-fe51747652e4',		ProjectKey: 'e381c719-d7fc-471a-b50c-fe51747652e4',
	JudgeId: '674907d1-60db-443b-b3c9-4755564c94a9',		JudgeId: '674907d1-60db-443b-b3c9-4755564c94a9',
	Score: 98.2		Score: 98.2,
			Notes: 'Your project was great!', //optional
	},		},
			ClearOldScores: true, //(true or false) Optional, default is true
	...		...
	]		]

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

2020-12-12T22:15:07Z

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

New page

== Upload Judging Scores ==
You can use our api to upload your judges scores. 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: 123,
Assignments:[{
ProjectKey: 'e381c719-d7fc-471a-b50c-fe51747652e4',
JudgeId: '674907d1-60db-443b-b3c9-4755564c94a9',
Score: 98.2
},
...
]
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

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