API Add Category - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:01Z

Remove username/password API auth; ApiKey only

← Older revision		Revision as of 12: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 add/update category fields

2026-07-25T18:49:43Z

Document add/update category fields

← Older revision		Revision as of 12:49, 25 July 2026
Line 1:		Line 1:
	== Add Category ==		== Add Category ==
	~~You can use our api to add categories 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 project category for the fair.

			=== 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/category', {		fetch('/api/data/category', {
	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: {
	Name: "~~Category Name~~",		Id: 0, // 0 for new
	NameShort: "~~Category Abbreviation~~",		Name: "Biology",
	Description: "", ~~//optional~~		NameShort: "BIO",
	Grades: [9,10,11,12], //optional~~, use 0 for kindergarten. If not set category will be open to all grades~~		Description: "Life sciences",
	~~Id: 123 //optional, this will cause the category at this id to be updated,~~		Grades: [6,7,8,9,10,11,12], // optional grade filter
	DoNotShowInOnlineJudging: false, ~~//optional~~		DoNotShowInOnlineJudging: false,
	DoNotAllowTeams: false, ~~//optional~~		DoNotAllowTeams: false,
	MaxTeamSize: 3, ~~//optional, by default there is no limit to the size of a team~~		MaxTeamSize: 3,
	EntryTypeId: 2, //optional, ~~this value comes back~~ from ~~the info api call~~		EntryTypeId: 1 // optional, from Get Info EntryTypes
	}		}
	})		})
	})		})
Line 26:		Line 58:
	.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>		</syntaxhighlight>

			=== Response ===
			On success <code>Body</code> is the category with <code>Id</code> set:

	~~== Remove Category ==~~		<pre>
			{
			Success: true,
			Message: null,
			Body: { Id: 12, Name: "Biology", NameShort: "BIO", ... }
			}
			</pre>

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

	~~fetch('~~/~~api~~/~~data~~/~~category/remove', {~~		=== Field notes ===
	~~method:'POST',~~		* Use returned <code>Id</code> as <code>CategoryId</code> when adding/updating projects.
	~~headers:{'Content-Type': 'application/json'},~~		* <code>Grades</code> is stored as a category grade filter when provided.
	~~body: JSON~~.~~stringify({~~		* Categories can be listed via [[API Get Info]] → <code>Categories</code>.
	~~ApiKey:'~~<~~Private key~~>',
	~~FairId: '9df61f13-474b-442f-ac1f-edca7348ef71',~~ /~~/This value can be found in your url it's the value of f~~
	~~Body: {~~
	~~Id: 123 //optional, this will cause the~~ category ~~at this id to be updated~~
	}
	})
	})
	~~.then(response => response~~.~~json())~~
	~~.then(data=~~>~~{console.log('Success: ',data);})~~
	~~.catch((error)=~~>~~{console~~.~~log('Error: ', error);});~~

	~~</syntaxhighlight>~~

			=== Related APIs ===
			* [[API Get Info]]
			* [[API Add Project]] / [[API Update Project]]


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

Trent at 22:01, 9 April 2024

2024-04-09T22:01:33Z

← Older revision		Revision as of 16:01, 9 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: {
Line 39:		Line 38:
	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: {

Trent at 16:44, 16 December 2021

2021-12-16T16:44:26Z

← Older revision		Revision as of 10:44, 16 December 2021
Line 20:		Line 20:
	DoNotAllowTeams: false, //optional		DoNotAllowTeams: false, //optional
	MaxTeamSize: 3, //optional, by default there is no limit to the size of a team		MaxTeamSize: 3, //optional, by default there is no limit to the size of a team
			EntryTypeId: 2, //optional, this value comes back from the info api call
	}		}
	})		})

Michael at 21:08, 3 November 2021

2021-11-03T21:08:26Z

← Older revision		Revision as of 15:08, 3 November 2021
Line 51:		Line 51:

	</syntaxhighlight>		</syntaxhighlight>



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

Trent at 20:53, 7 November 2020

2020-11-07T20:53:03Z

← Older revision		Revision as of 14:53, 7 November 2020
Line 14:		Line 14:
	Name: "Category Name",		Name: "Category Name",
	NameShort: "Category Abbreviation",		NameShort: "Category Abbreviation",
	Description: "",		Description: "", //optional
	Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades		Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades
	Id: 123 //optional, this will cause the category at this id to be updated,		Id: 123 //optional, this will cause the category at this id to be updated,

Trent at 20:52, 7 November 2020

2020-11-07T20:52:48Z

← Older revision		Revision as of 14:52, 7 November 2020
Line 16:		Line 16:
	Description: "",		Description: "",
	Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades		Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades
	Id: 123 //optional, this will cause the category at this id to be updated		Id: 123 //optional, this will cause the category at this id to be updated,
			DoNotShowInOnlineJudging: false, //optional
			DoNotAllowTeams: false, //optional
			MaxTeamSize: 3, //optional, by default there is no limit to the size of a team
	}		}
	})		})

Trent at 20:49, 7 November 2020

2020-11-07T20:49:07Z

← Older revision		Revision as of 14:49, 7 November 2020
Line 10:		Line 10:
	Username:'admin username',		Username:'admin username',
	Password: 'password',		Password: 'password',
			FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
	Body: {		Body: {
	Name: "Category Name",		Name: "Category Name",
	NameShort: "Category Abbreviation",		NameShort: "Category Abbreviation",
	Description: "",		Description: "",
	Grades: [9,10,11,12] //optional, use 0 for kindergarten. If not set category will be open to all grades		Grades: [9,10,11,12], //optional, use 0 for kindergarten. If not set category will be open to all grades
	Id: 123 //optional, this will cause the category at this id to be updated		Id: 123 //optional, this will cause the category at this id to be updated
	}		}
Line 36:		Line 37:
	Username:'admin username',		Username:'admin username',
	Password: 'password',		Password: 'password',
			FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
	Body: {		Body: {
	Id: 123 //optional, this will cause the category at this id to be updated		Id: 123 //optional, this will cause the category at this id to be updated

Trent at 17:49, 7 November 2020

2020-11-07T17:49:51Z

← Older revision		Revision as of 11:49, 7 November 2020
Line 12:		Line 12:
	Body: {		Body: {
	Name: "Category Name",		Name: "Category Name",
	NameShort: "Category ~~Abbriviation~~",		NameShort: "Category Abbreviation",
	Description: "",		Description: "",
	Grades: [9,10,11,12] //optional, use 0 for ~~kindergarden~~. If not set category will be open to all grades		Grades: [9,10,11,12] //optional, use 0 for kindergarten. If not set category will be open to all grades
	Id: 123 //optional, this will cause the category at this id to be updated		Id: 123 //optional, this will cause the category at this id to be updated
	}		}

Trent: Created page with "== Add Category == You can use our api to add categories 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...."

2020-11-05T17:39:12Z

Created page with "== Add Category == You can use our api to add categories 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...."

New page

== Add Category ==
You can use our api to add categories 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/category', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
Body: {
Name: "Category Name",
NameShort: "Category Abbriviation",
Description: "",
Grades: [9,10,11,12] //optional, use 0 for kindergarden. If not set category will be open to all grades
Id: 123 //optional, this will cause the category at this id to be updated
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

== Remove Category ==

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/category/remove', {
method:'POST',
headers:{'Content-Type': 'application/json'},
body: JSON.stringify({
Username:'admin username',
Password: 'password',
Body: {
Id: 123 //optional, this will cause the category at this id to be updated
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>