API Add Person
From zFairs Contest Management
Add Person
You can use our api to add a teacher or judge to your contest. To do this you need to POST a message to your site. Below is an example of what needs to be posted.
fetch('/api/data/person', {
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: {
FirstName: 'Jane'
,LastName: 'Doe'
,Prefix: 'Dr'
,Email: 'jane@example.com'
,Email1: 'Doe@example.com'
,Phone: '800-000-0000'
,Phone1: '800-123-1324'
,Address: '1219 45th st'
,Address2: 'APT 3B'
,City: 'Ogden'
,State: 'VA'
,Zip: '65951'
,SchoolsTeachesAt: [1] // int array of school ids
,Role: 'Teacher' // { Teacher, Judge, Staff, Admin, Volunteer}
,Language:'Spanish' //optional - interpreter need for this language
,JudgesPreferences:{ //optional
Category1: 123,
...
}
}
})
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});
Additional Optional fields
All of these fields would be part of the body.
- Username (string max length 25)
- If this username is not available one will be assigned
- Password (string max length 25)
- Middle Name
- ExternalId (string: can be used to match to your records)
- Race
- Ethnicity
- African American
- Asian/Pacific Islander
- Caucasian
- Hispanic
- Indian/So. Asian
- Native American
- Unknown/Declined to state
- Gender
- F = Female
- M = Male
- O = Other
- N = Non-binary
- Z = Prefer not to answer
- HighestLevelOfEducation
- Less Than HS Graduate
- High School Diploma or Equivalent
- Some College
- Technical School
- 2-Year College Degree
- 4-Year College Degree
- Some Graduate School
- Master's Level Degree
- Doctorate (Academic)
- Doctorate (Professional)
- Not Indicated
- JobTitle
- Employer
- DateOfBirth (yyyy-mm-dd)
- FullLegalName
- BackgroundcheckAtUtc (yyyy-mm-dd)
- BackgroundCheckStatus
- JudgesPreferences (object)
- this is an object, which can be added to body. like JudgesPreferences: { /* add the following optional parameters below */}
- you need to provide the category id's in the category1-3
- you need to provide judging Session id's for judgingSessions array
- See API_Get_Info to get these id's
- Category1 (int)
- Category2 (int)
- Category3 (int)
- PreviouslyJudged (boolean true/false)
- JudgingSessions (int array)
- Not provided will not update sessions, empty array will clear out sessions for that judge.
- example [] or [1,2,...]
- IsSpecialAwardJudge (boolean true/false)
- IsModerator (boolean true/false)
- IsInterpreter (boolean true/false)