API Get Projects - Revision history

Trent: Add participantNUsername and paperwork reviewer comment chain fields

2026-07-25T19:19:47Z

Add participantNUsername and paperwork reviewer comment chain fields

Trent at 18:37, 25 July 2026

2026-07-25T18:37:14Z

Trent at 18:29, 25 July 2026

2026-07-25T18:29:49Z

Show changes

Trent at 21:59, 9 April 2024

2024-04-09T21:59:32Z

Trent at 21:48, 9 April 2024

2024-04-09T21:48:16Z

Trent at 21:47, 9 April 2024

2024-04-09T21:47:52Z

Michael at 21:09, 3 November 2021

2021-11-03T21:09:21Z

Trent: Created page with "== Get Projects == Get a list of projects from our API. fetch('/api/data/projects', { method:'POST', headers:{'Content-Type'..."

2021-06-15T21:00:14Z

Created page with "== Get Projects == Get a list of projects from our API. <syntaxhighlight lang="JavaScript" line> fetch('/api/data/projects', { method:'POST', headers:{'Content-Type'..."

New page

== Get Projects ==
Get a list of projects from our API.

<syntaxhighlight lang="JavaScript" line>

fetch('/api/data/projects', {
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: {}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

</syntaxhighlight>

@@ Line 82: / Line 82: @@
        participant1Email: "alice@example.com",
        participant1Phone: "800-000-0000",
        participant1Id: "person-guid",
        participant1IdInt: 1001,
@@ Line 89: / Line 90: @@
        participant2Email: "bob@example.com",
        participant2Phone: "800-000-0001",
        participant2Id: "person-guid-2",
        participant2IdInt: 1002,
@@ Line 96: / Line 98: @@
        participant3Email: null,
        participant3Phone: null,
        participant3Id: null,
        participant3IdInt: null,
@@ Line 103: / Line 106: @@
        participant4Email: null,
        participant4Phone: null,
        participant4Id: null,
        participant4IdInt: null,
@@ Line 110: / Line 114: @@
        participant5Email: null,
        participant5Phone: null,
        participant5Id: null,
        participant5IdInt: null,
@@ Line 135: / Line 140: @@
          path: "https://yoursite.zfairs.com/file/showfile/file-guid",
          paperworkFileTypeId: 123,
-         fileStatus: 1
+         fileStatus: 1,                 // 100=new, 200=needsWork, 300=pending, 500=accepted, etc.
        }],
@@ Line 178: / Line 195: @@
 |-
 | <code>participantNPhone</code> || Phone
 |-
 | <code>participantNId</code> || Person public GUID
@@ Line 195: / Line 214: @@
 * '''teachers''' – array of teacher display values from the project record.
 * '''paperworkFiles''' – paperwork only. Use [[API Get Info]] for paperwork file type ids/names.
 * '''projectFiles''' – uploaded project assets '''and''' paperwork files combined. Prefer '''paperworkFiles''' if you only need paperwork.
 * '''path''' on files and packet responses – direct URL to download/view via <code>/file/showfile/{publicId}</code>.

@@ Line 71: / Line 71: @@
          firstName: "Alice",
          lastName: "Example",
          email: "alice@example.com",
-         phone: "800-000-0000",
+         phone: "800-000-0000"
-         address: "123 Main St",
+         // ... additional participant fields
        }],
        mentors: [{
@@ Line 107: / Line 126: @@
        }],
        paperworkFiles: [{
-         name: "Form 1C",               // paperwork file type name
+         name: "Form 1C",
          type: "paperwork",
          createdAtUtc: "2024-03-01T10:00:00Z",
@@ Line 116: / Line 134: @@
          fileName: "form1c.pdf",
          path: "https://yoursite.zfairs.com/file/showfile/file-guid",
-         paperworkFileTypeId: 123,      // from API Get Info → PaperworkFileTypes
+         paperworkFileTypeId: 123,
          fileStatus: 1
        }],
@@ Line 122: / Line 140: @@
        // All project files: uploaded assets PLUS paperwork files
        projectFiles: [{
-         name: "myAwesomeFile.png",     // or paperwork type name for paperwork entries
+         name: "myAwesomeFile.png",
-         type: "image",                 // asset file type, or "paperwork"
+         type: "image",
          createdAtUtc: "2024-03-01T10:00:00Z",
          fileUpdatedAtUtc: "2024-03-01T10:00:00Z",
          publicId: "file-guid",
          fileName: "myAwesomeFile.png",
-         path: "https://yoursite.zfairs.com/file/showfile/file-guid",
+         path: "https://yoursite.zfairs.com/file/showfile/file-guid"
        }],
        packetResponses: [{
          packetName: "SRC Packet",
          formName: "Form 1B",
-         comments: [{
+         comments: [],
          fileKey: "file-guid",
          fileKeyLastUpdate: "2024-03-10T15:00:00Z",
          status: "Approved",
-         jsonDetails: "{...}",          // raw form detail JSON string
+         jsonDetails: "{...}",
-         path: "https://yoursite.zfairs.com/file/showfile/file-guid" // null when no fileKey
+         path: "https://yoursite.zfairs.com/file/showfile/file-guid"
        }]
      }]
@@ Line 158: / Line 163: @@
+}
 </syntaxhighlight>
 === Field notes ===

← Older revision		Revision as of 21:09, 3 November 2021
Line 19:		Line 19:

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

@@ Line 9: / Line 9: @@
      body: JSON.stringify({
              ApiKey:'<Private key>',
-             FairId: '0abbed7d-14f5-47bc-865b-0c2878feb205', //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: {}
          })