Create a new user in Edgenuity. Leave fields null if they are not applicable.
Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)
Syntax
public CreateUserResults CreateUser( string apiUsername, string apiPassword, string SchoolExternalID, string UserExternalID, string Username, string Password, Role Role, Status Status, string FirstName, string LastName, string MiddleName, string Email, string Street, string City, string Zip, string State, string HomePhone, string AltPhone, Nullable<int> GradeLevel, Nullable<DateTime> BirthDate, Nullable<Gender> StudentGender, string Notes, Nullable<bool> ForceOrientation, Nullable<bool> EnableTTS, Nullable<bool> EnableTranslation, Nullable<bool> CollegeBound, Nullable<Race> Race, Nullable<Lunch> Lunch, Nullable<ELL> ELL )
Parameters
- apiUsername
- Type: SystemString
API Username - apiPassword
- Type: SystemString
API Password - SchoolExternalID
- Type: SystemString
External School ID where the user should be created. If this is NULL, you must have a holding school to place users in until a proper school is sent - UserExternalID
- Type: SystemString
Required: External User ID of the user - Username
- Type: SystemString
Required: Username requested for the new user - Password
- Type: SystemString
Required: Password for the new user - Role
- Type: EnumerationsRole
Required: Is the user a student or teacher - Status
- Type: EnumerationsStatus
Required: Should the user be created as enabled or disabled - FirstName
- Type: SystemString
Required: First Name - LastName
- Type: SystemString
Required: Last Name - MiddleName
- Type: SystemString
Middle Name - Type: SystemString
Email Address - Street
- Type: SystemString
Street Address - City
- Type: SystemString
City - Zip
- Type: SystemString
Zip Code - State
- Type: SystemString
State - HomePhone
- Type: SystemString
Home Phone - AltPhone
- Type: SystemString
Alt Phone - GradeLevel
- Type: SystemNullableInt32
Required for Students: Grade Level - BirthDate
- Type: SystemNullableDateTime
Date of Birth - StudentGender
- Type: SystemNullableGender
Gender - Notes
- Type: SystemString
Notes - ForceOrientation
- Type: SystemNullableBoolean
Require a student to watch the Edgenuity orientation video on their next login. If null, the default for the school will be used. - EnableTTS
- Type: SystemNullableBoolean
Enable Text to Speech for a user. If null, the default for the school will be used. - EnableTranslation
- Type: SystemNullableBoolean
Enable Translation for a user. If null, the default for the school will be used. - CollegeBound
- Type: SystemNullableBoolean
Is the student college bound - Race
- Type: SystemNullableRace
Race of the student - Lunch
- Type: SystemNullableLunch
Is the student eligible for free or reduced lunch - ELL
- Type: SystemNullableELL
Is the student an English Language Learner
Return Value
Type: CreateUserResultsThe Edgenuity User ID and Username for the new user
See Also