API Get Teachers: Difference between revisions

From zFairs Contest Management
Michael (talk | contribs)
No edit summary
Remove username/password API auth; ApiKey only
 
(2 intermediate revisions by 2 users not shown)
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.
|-
| <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.
|}
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',
     headers:{'Content-Type': 'application/json'},
     headers:{'Content-Type': 'application/json'},
     body: JSON.stringify({
     body: JSON.stringify({
             Username:'admin username',
             ApiKey:'<Private key>',
            Password: 'password',
             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
             FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
             Body: {}
             Body: {}
         })
         })
Line 17: Line 45:
.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]]

Latest revision as of 11:55, 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.
FairId Yes Fair GUID from the site URL (f query parameter).
Body Depends Request payload. Use {} when no body fields are needed.


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.