API Add Project - Revision history

Peter at 03:48, 11 April 2024

2024-04-11T03:48:26Z

Trent: /* Where to get values */

2023-02-27T19:36:19Z

Where to get values

Trent at 18:55, 29 April 2022

2022-04-29T18:55:16Z

Trent at 17:44, 29 April 2022

2022-04-29T17:44:58Z

Trent at 21:20, 17 March 2022

2022-03-17T21:20:54Z

Trent at 16:48, 16 December 2021

2021-12-16T16:48:33Z

Michael at 21:08, 3 November 2021

2021-11-03T21:08:15Z

Trent at 15:46, 16 February 2021

2021-02-16T15:46:10Z

Trent at 15:45, 16 February 2021

2021-02-16T15:45:35Z

Trent at 15:19, 16 February 2021

2021-02-16T15:19:14Z

@@ 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>

@@ Line 49: / Line 49: @@
 				}],
-				"Files": [{
+				"CustomQuestions" : //optional
-           				"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl
+					[{
-           				"DownloadFromUrl":"http://yoursite.com/somefile.png",//optional can be used in stead of Base64String
+						"Id": 123,
-           				"FileName": "myAwesomeFile.png",
+						"Value": "This is my answer"
-           				"Caption": "indescribable"
+					},...]
-           				},
+				"Files": //optional
+					[{
-           				"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...",
+           					"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl
-           				"FileName": "myAwesomeFile2.png",
+           					"DownloadFromUrl":"http://yoursite.com/somefile.png",//optional can be used in stead of Base64String
-           				"Caption": "indescribable also"
+         	  				"FileName": "myAwesomeFile.png",
-           				},
+           					"Caption": "indescribable"
+           					},
-           				"DownloadFromUrl":"http://yoursite.com/somefile.png",
-           				"FileName": "myAwesomething.pdf",
+           					"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...",
-           				"Caption": "indescribable pdf"
+           					"FileName": "myAwesomeFile2.png",
             				}]
+			}
@@ Line 75: / Line 81: @@
 == Where to get values ==
-Various fields need id values such as '''CategoryId''', '''CategoryAwardId''', and '''SpecialAwardIds'''. You can get these values from our API. Check out [[API Get Info]]
+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]]
 === Additional Optional fields of Participants ===

@@ Line 18: / Line 18: @@
 				,Abstract: 'Project Abstract'// optional
 				,Description: 'Project Description'// optional
-                                ,ProjectKey: ’36 char GUID’//optional
+				,ProjectKey: ’36 char GUID’//optional
-                                ,EntryVideoLink: ‘video Link’ //optional
+				,EntryVideoLink: ‘video Link’ //optional
 				,CategoryAwardId: 1 // optional
 				,SpecialAwardsIds: [1, 2] //optional