API Add Person - Revision history

Peter at 03:47, 11 April 2024

2024-04-11T03:47:32Z

2022-10-17T23:23:07Z

2022-10-17T23:17:33Z

2022-03-17T21:24:02Z

Add Person

2022-03-17T21:22:58Z

2022-03-17T21:22:32Z

2021-11-03T21:07:29Z

2021-04-23T20:36:41Z

2021-04-15T14:44:36Z

Additional Optional fields

2021-04-15T14:43:50Z

Additional Optional fields

@@ Line 8: / Line 8: @@
      headers:{'Content-Type': 'application/json'},
      body: JSON.stringify({
-		Username:'admin username',
+		ApiKey:'<Private key>',
 		FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
 		Body: {

← Older revision		Revision as of 23:23, 17 October 2022
Line 97:		Line 97:
	*'''IsModerator''' (boolean true/false)		*'''IsModerator''' (boolean true/false)
	*'''IsInterpreter''' (boolean true/false)		*'''IsInterpreter''' (boolean true/false)
		+	*'''RequirePasswordChange''' (boolean true/false) requires user to change password on their first sign-in.

← Older revision		Revision as of 23:17, 17 October 2022
Line 99:		Line 99:


		+	=== Notes ===
		+
		+	When you call the /person API you can set the username, if the username you provided is not available we add a number to the end of it. Spaces are removed from the username.
		+
		+	If you do not provide a password when you call the /person api then none is set and the account will need to have a password set before you can login with this person. A user can use their name and email to reset the password.

	<br/><br/><br/><br/>		<br/><br/><br/><br/>
	[[Category: API]]		[[Category: API]]

@@ Line 8: / Line 8: @@
      headers:{'Content-Type': 'application/json'},
      body: JSON.stringify({
-            Username:'admin username',
+		Username:'admin username',
-            Password: 'password',
+		Password: 'password',
-            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', //This value can be found in your url it's the value of f
-            Body: {
+		Body: {
 			FirstName: 'Jane'
 			,LastName: 'Doe'

@@ Line 12: / Line 12: @@
              FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', //This value can be found in your url it's the value of f
              Body: {
-                        FirstName: 'Jane'
+			FirstName: 'Jane'
 			,LastName: 'Doe'
 			,Prefix: 'Dr'

@@ Line 26: / Line 26: @@
 			,SchoolsTeachesAt: [1] // int array of school ids
 			,Role: 'Teacher' // { Teacher, Judge, Staff, Admin, Volunteer}
 			,JudgesPreferences:{ //optional
 			   Category1: 123,

← Older revision		Revision as of 21:07, 3 November 2021
Line 96:		Line 96:
	*'''IsModerator''' (boolean true/false)		*'''IsModerator''' (boolean true/false)
	*'''IsInterpreter''' (boolean true/false)		*'''IsInterpreter''' (boolean true/false)
		+
		+
		+
		+	<br/><br/><br/><br/>
		+	[[Category: API]]

← Older revision		Revision as of 20:36, 23 April 2021
Line 93:		Line 93:
	****Not provided will not update sessions, empty array will clear out sessions for that judge.		****Not provided will not update sessions, empty array will clear out sessions for that judge.
	****example [] or [1,2,...]		****example [] or [1,2,...]
		+	*'''IsSpecialAwardJudge''' (boolean true/false)
		+	*'''IsModerator''' (boolean true/false)
		+	*'''IsInterpreter''' (boolean true/false)

@@ Line 47: / Line 47: @@
 * '''Password''' (string max length 25)
 * '''Middle Name'''
-* '''ExternalId'''
+* '''ExternalId''' (string: can be used to match to your records)
 * '''Race'''
 * '''Ethnicity'''