API Add Round - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:04Z

Remove username/password API auth; ApiKey only

Trent: Document add/update judging round

2026-07-25T18:49:42Z

Document add/update judging round

Peter at 03:48, 11 April 2024

2024-04-11T03:48:53Z

Trent at 17:47, 31 December 2020

2020-12-31T17:47:48Z

Trent at 17:47, 31 December 2020

2020-12-31T17:47:22Z

Trent: Created page with "== Add Judging Round == You can use our api to add judging '''Rounds''' to your contest. To do this you need to POST a message to your site. Below is an example of what needs..."

2020-12-31T04:23:56Z

Created page with "== Add Judging Round == You can use our api to add judging '''Rounds''' to your contest. To do this you need to POST a message to your site. Below is an example of what needs..."

New page

== Add Judging Round ==
You can use our api to add judging '''Rounds''' 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/round', {
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: {
RoundName: "Round Name",
RoundValue: 100, //0-100
IsSubRound: false, // false or true
Id: 0 //0 to create a new round, or the round Id to update an existing round
}
})
})
.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: @@
-== Add Judging Round ==
+== Add Round ==
-You can use our api to add judging '''Rounds''' 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 judging round for the fair.
 <syntaxhighlight lang="JavaScript" line>
 fetch('/api/data/round', {
      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: {
-				RoundName: "Round Name",
+				Id: 0,              // 0 for new round
-				RoundValue: 100, //0-100
+				RoundName: "Round One",  // required
-				IsSubRound: false, // false or true
+				RoundValue: 100,    // optional, default 100
-				Id: 0 //0 to create a new round, or the round Id to update an existing round
+				IsSubround: false   // optional, default false
-−
+			}
          })
 })
@@ Line 21: / Line 53: @@
 .then(data=>{console.log('Success: ',data);})
 .catch((error)=>{console.log('Error: ', error);});
-<br/><br/><br/><br/>
+<br/><br/>
 [[Category: API]]

@@ Line 25: / Line 25: @@
 </syntaxhighlight>
-<br/><br/<>br/><br/>
+<br/><br/><br/><br/>
 [[Category: API]]

← Older revision		Revision as of 17:47, 31 December 2020
Line 24:		Line 24:

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