API Add Project - Revision history

Trent: Remove username/password API auth; ApiKey only

2026-07-25T18:55:03Z

Remove username/password API auth; ApiKey only

2026-07-25T18:49:45Z

Document add project payload and response

2024-04-11T03:48:26Z

2023-02-27T19:36:19Z

Where to get values

2022-04-29T18:55:16Z

2022-04-29T17:44:58Z

2022-03-17T21:20:54Z

2021-12-16T16:48:33Z

2021-11-03T21:08:15Z

2021-02-16T15:46:10Z

@@ 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 10: / Line 10: @@
      headers:{'Content-Type': 'application/json'},
      body: JSON.stringify({
-             Username:'admin username',
+             ApiKey:'<Private key>',
              FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
              Body: {

@@ Line 89: / Line 89: @@
 Various fields need id values such as '''CategoryId''', '''CustomQuestion Ids''', '''CategoryAwardId''', and '''SpecialAwardIds'''. You can get these values from our API. Check out [[API Get Info]]
 A participant record is very similar to a teacher record see [[API Add Person]] for optional fields of participants.
 You can also add '''FixedProjectId''', this allows you to upload the project Id you want to be used for your uploaded project.

@@ Line 27: / Line 27: @@
 				,EntryTypeId: 2 //optional value come from info api
 				,Language:'Spanish' //optional - interpreter need for this language
-				,InPerson:'Yes' //optional - 'Yes' or 'No'
+				,InPerson:'Yes' //optional - 'yes' or 'no'
 				,Participants : [{
 					FirstName: 'Jane' //Required

@@ Line 27: / Line 27: @@
 				,EntryTypeId: 2 //optional value come from info api
 				,Language:'Spanish' //optional - interpreter need for this language
 				,Participants : [{
 					FirstName: 'Jane' //Required

@@ Line 26: / Line 26: @@
 				,SpecialAwardsIds: [1, 2] //optional
 				,EntryTypeId: 2 //optional value come from info api
 				,Participants : [{
 					FirstName: 'Jane' //Required
@@ Line 45: / Line 46: @@
                                          ,Username: 'Student User Name' //optional
                                          ,Password:  'Student Password' //optional
 					,ProfilePicture: { //Optional
 						Base64String: 'base64 file string',

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

	You can also add '''FixedProjectId''', this allows you to upload the project Id you want to be used for your uploaded project.		You can also add '''FixedProjectId''', this allows you to upload the project Id you want to be used for your uploaded project.
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]

@@ Line 1: / Line 1: @@
 == Add Project==
 You can use our api to add a project and it's participants 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>