Difference between revisions of "API Get Teachers"

From zFairs Contest Management
(Document teachers list response)
Line 1: Line 1:
 
== Get Teachers ==
 
== Get Teachers ==
−
Get a list of teachers from our API.
+
Returns teachers for the client, with linked schools and person tags.
  
 +
=== 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/teachers', {
 
fetch('/api/data/teachers', {
 
     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: {}
 
         })
 
         })
Line 16: Line 48:
 
.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>
 +
 +
=== Response ===
 +
On success <code>Body</code> looks like:
  
 +
<syntaxhighlight lang="JavaScript">
 +
{
 +
  Success: true,
 +
  Message: null,
 +
  Body: {
 +
    teachers: [{
 +
      id: "person-guid",
 +
      idInt: 55,
 +
      firstName: "Jane",
 +
      lastName: "Smith",
 +
      username: "jsmith",
 +
      email: "jsmith@example.edu",
 +
      phone: "801-555-0200",
 +
      address: "12 Oak St",
 +
      address2: null,
 +
      city: "Ogden",
 +
      state: "UT",
 +
      zip: "84401",
 +
      schools: [{ id: 24, name: "Example School" }],
 +
      tags: ["STEM Lead"]
 +
    }]
 +
  }
 +
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 +
 +
=== Field notes ===
 +
* Temporary/placeholder people are excluded.
 +
* Teachers may appear with multiple schools; results are grouped by person.
 +
* Use teacher <code>id</code> (GUID) as <code>TeacherId</code> when adding project participants.
 +
 +
 +
=== Related APIs ===
 +
* [[API Add Person]]
 +
* [[API Get Schools]]
 +
* [[API Add Project]]
  
  
−
<br/><br/><br/><br/>
+
<br/><br/>
 
[[Category: API]]
 
[[Category: API]]

Revision as of 12:49, 25 July 2026

Get Teachers

Returns teachers for the client, with linked schools and person tags.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field Required Description
ApiKey Yes* Private API key for your site. Prefer this over username/password.
Username / Password Yes* Alternate auth if not using ApiKey.
FairId Yes Fair GUID from the site URL (f query parameter).
Body Depends Request payload. Use {} when no body fields are needed.
  • Provide either ApiKey or Username+Password.

Calls must be run server-side — do not expose your API key in a browser.

Response envelope

Most endpoints return: 

{
  Success: true,
  Message: null,   // error text when Success is false
  Body: { ... }    // endpoint-specific payload
}


Request

fetch('/api/data/teachers', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
            Body: {}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success Body looks like: 

{
  Success: true,
  Message: null,
  Body: {
    teachers: [{
      id: "person-guid",
      idInt: 55,
      firstName: "Jane",
      lastName: "Smith",
      username: "jsmith",
      email: "jsmith@example.edu",
      phone: "801-555-0200",
      address: "12 Oak St",
      address2: null,
      city: "Ogden",
      state: "UT",
      zip: "84401",
      schools: [{ id: 24, name: "Example School" }],
      tags: ["STEM Lead"]
    }]
  }
}


Field notes

  • Temporary/placeholder people are excluded.
  • Teachers may appear with multiple schools; results are grouped by person.
  • Use teacher id (GUID) as TeacherId when adding project participants.


Related APIs




Retrieved from "https://wiki.zFairs.com/index.php?title=API_Get_Teachers&oldid=934"