API Upload Project Assets - Revision history

Peter at 03:58, 11 April 2024

2024-04-11T03:58:18Z

Michael at 21:10, 3 November 2021

2021-11-03T21:10:34Z

Preston at 22:56, 19 August 2021

2021-08-19T22:56:00Z

Trent: /* Upload Project Paperwork */

2020-11-25T03:33:47Z

Upload Project Paperwork

Trent: Trent moved page API Upload Project Image to API Upload Project Assets

2020-11-23T21:37:05Z

Trent moved page API Upload Project Image to API Upload Project Assets

Trent at 21:34, 23 November 2020

2020-11-23T21:34:18Z

Trent at 21:33, 23 November 2020

2020-11-23T21:33:34Z

Trent at 21:41, 9 November 2020

2020-11-09T21:41:52Z

Trent at 17:51, 7 November 2020

2020-11-07T17:51:05Z

Trent: Created page with "== Upload Project Image == You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message t..."

2020-11-05T20:43:45Z

Created page with "== Upload Project Image == You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message t..."

New page

== Upload Project Image ==
You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. 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/project', {
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: {
"ProjectKey":"32161f13-474b-442f-ac1f-edca7348e000"
"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...",
"DownloadFromUrl":"http://yoursite.com/somefile.png" //optional can be used in stead of Base64String
"FileName": "myAwesomeFile.png",
"Caption": "indescribable"
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

← Older revision		Revision as of 21:10, 3 November 2021
Line 54:		Line 54:

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

@@ Line 2: / Line 2: @@
 === Upload Project Image ===
-You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
+You can use our API to upload images to a project, so these can be viewed by your judges or in the showcase. 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 29: / Line 29: @@
 === Upload Project Paperwork  ===
-You can use our api to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs, you will need to get the PaperworkFileType form the [[API Get Info]]. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
+You can use our API to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs. You will need to get the PaperworkFileType form the [[API Get Info]]. 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 45: / Line 45: @@
 				"Base64String" : "iVBORw0KGgoAAAANSUhEUgAAAQIAA...", //not required if you use DownloadFromUrl
 				"DownloadFromUrl":"http://yoursite.com/somefile.png", //optional can be used in stead of Base64String
-				"FileName": "myAwesomeFile.png",
+				"FileName": "myAwesomeFile.png"
+			}
          })

@@ Line 1: / Line 1: @@
-== Upload Project Image ==
+== Upload Project Assets ==
 You can use our api to upload images to a project, so these can be viewed by your judges or in the showcase. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
@@ Line 26: / Line 28: @@
 </syntaxhighlight>
-== Upload Project Paperwork  ==
+=== Upload Project Paperwork  ===
 You can use our api to upload project paperwork, so these can be viewed by your judges, SRC, and IRB. These files need to be PDFs, you will need to get the PaperworkFileType form the [[API Get Info]]. To do this you need to POST a message to your site. Below is an example of what needs to be posted.

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

← Older revision	Revision as of 21:37, 23 November 2020
(No difference)

@@ Line 4: / Line 4: @@
 <syntaxhighlight lang="JavaScript" line>
-fetch('/api/data/project', {
+fetch('/api/data/project/file', {
      method:'POST',
      headers:{'Content-Type': 'application/json'},