Difference between revisions of "API Get Judges"

From zFairs Contest Management
(Document judges list response for assignments/scores)
(Remove username/password API auth; ApiKey only)
 
Line 9: Line 9:
 
! Field !! Required !! Description
 
! Field !! Required !! Description
 
|-
 
|-
| <code>ApiKey</code> || Yes* || Private API key for your site. Prefer this over username/password.
+
| <code>ApiKey</code> || Yes || Private API key for your site.
|-
 
| <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>FairId</code> || Yes || Fair GUID from the site URL (<code>f</code> query parameter).
Line 18: Line 16:
 
|}
 
|}
  
* 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.
 
Calls must be run '''server-side''' — do not expose your API key in a browser.

Latest revision as of 12:55, 25 July 2026

Get Judges

Returns judges for the fair, including contact info, category preferences, assigned category, sessions, and check-in time.

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/judges', {
    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: {
    judges: [{
      id: "judge-public-guid",   // use this as JudgeId in assignment/score APIs
      idInt: 9001,
      firstName: "Sam",
      lastName: "Judge",
      username: "sjudge",
      email: "sam@example.com",
      phone: "801-555-0300",
      address: "5 Court St",
      address2: null,
      city: "Ogden",
      state: "UT",
      zip: "84401",
      tags: ["Experienced"],
      categoryPreference1: 12,
      categoryPreferenceName1: "Biology",
      categoryPreference2: 13,
      categoryPreferenceName2: "Chemistry",
      categoryPreference3: null,
      categoryPreferenceName3: null,
      happToJudgeAnyCategory: true,
      roamingJudgeWilling: false,
      judgeCaptainWilling: true,
      highestLvlOfEducation: "PhD",
      AssignedCategory: 12,
      AssignedCategoryName: "Biology",
      sessions: [1, 2],           // judging session ids
      checkInAtUtc: "2024-03-15T14:00:00Z"
    }]
  }
}


Field notes


Related APIs