Difference between revisions of "API Add Person"

From zFairs Contest Management
Line 25: Line 25:
 
,SchoolsTeachesAt: [1] // int array of school ids
 
,SchoolsTeachesAt: [1] // int array of school ids
 
,Role: 'Teacher' // { Teacher, Judge, Staff, Admin, Volunteer}
 
,Role: 'Teacher' // { Teacher, Judge, Staff, Admin, Volunteer}
,Password: 'hello123'
 
,Username: 'User123' //If this username is not available one will be assigned
 
 
             }
 
             }
 
         })
 
         })
Line 35: Line 33:
  
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 +
 +
=== Additional Optional fields ===
 +
* Username (string max length 25)
 +
**If this username is not available one will be assigned
 +
* Password (string max length 25)
 +
* 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

Revision as of 10:10, 4 September 2020

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


Additional Optional fields

  • Username (string max length 25)
    • If this username is not available one will be assigned
  • Password (string max length 25)
  • 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