E2020API.UpdateStudent Method

E2020APIUpdateStudent Method

A Sandcastle Documented Class Library

[Missing <summary> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]

Namespace: WCFAPI
Assembly: WCFAPI (in WCFAPI.dll) Version: 4.0.0.0 (4.0.0.0)

Syntax

C++

Copy

public ApiResults UpdateStudent(
	string apiUsername,
	string apiPassword,
	string StudentExternalID,
	string FirstName,
	string MiddleName,
	string LastName,
	string RequestedUsername,
	string Password,
	string Email,
	string StreetAddress,
	string City,
	string PostalCode,
	string State,
	string HomePhone,
	string AltPhone,
	string ComputerPhone,
	int GradeLevel,
	DateTime BirthDate,
	Gender StudentGender,
	DateTime StartDate,
	string Notes,
	int Status,
	bool ShowEReader,
	bool ForceOrientation,
	int StandardReadering,
	int StandardWriting,
	int StandardMath,
	int StandardScience,
	int StandardSocial,
	bool CollegeBound,
	string Race,
	string Lunch,
	string EnglishLangLearner,
	string ActionData
)

Public Function UpdateStudent ( 
	apiUsername As String,
	apiPassword As String,
	StudentExternalID As String,
	FirstName As String,
	MiddleName As String,
	LastName As String,
	RequestedUsername As String,
	Password As String,
	Email As String,
	StreetAddress As String,
	City As String,
	PostalCode As String,
	State As String,
	HomePhone As String,
	AltPhone As String,
	ComputerPhone As String,
	GradeLevel As Integer,
	BirthDate As DateTime,
	StudentGender As Gender,
	StartDate As DateTime,
	Notes As String,
	Status As Integer,
	ShowEReader As Boolean,
	ForceOrientation As Boolean,
	StandardReadering As Integer,
	StandardWriting As Integer,
	StandardMath As Integer,
	StandardScience As Integer,
	StandardSocial As Integer,
	CollegeBound As Boolean,
	Race As String,
	Lunch As String,
	EnglishLangLearner As String,
	ActionData As String
) As ApiResults

public:
virtual ApiResults^ UpdateStudent(
	String^ apiUsername, 
	String^ apiPassword, 
	String^ StudentExternalID, 
	String^ FirstName, 
	String^ MiddleName, 
	String^ LastName, 
	String^ RequestedUsername, 
	String^ Password, 
	String^ Email, 
	String^ StreetAddress, 
	String^ City, 
	String^ PostalCode, 
	String^ State, 
	String^ HomePhone, 
	String^ AltPhone, 
	String^ ComputerPhone, 
	int GradeLevel, 
	DateTime BirthDate, 
	Gender StudentGender, 
	DateTime StartDate, 
	String^ Notes, 
	int Status, 
	bool ShowEReader, 
	bool ForceOrientation, 
	int StandardReadering, 
	int StandardWriting, 
	int StandardMath, 
	int StandardScience, 
	int StandardSocial, 
	bool CollegeBound, 
	String^ Race, 
	String^ Lunch, 
	String^ EnglishLangLearner, 
	String^ ActionData
) sealed

abstract UpdateStudent : 
        apiUsername : string * 
        apiPassword : string * 
        StudentExternalID : string * 
        FirstName : string * 
        MiddleName : string * 
        LastName : string * 
        RequestedUsername : string * 
        Password : string * 
        Email : string * 
        StreetAddress : string * 
        City : string * 
        PostalCode : string * 
        State : string * 
        HomePhone : string * 
        AltPhone : string * 
        ComputerPhone : string * 
        GradeLevel : int * 
        BirthDate : DateTime * 
        StudentGender : Gender * 
        StartDate : DateTime * 
        Notes : string * 
        Status : int * 
        ShowEReader : bool * 
        ForceOrientation : bool * 
        StandardReadering : int * 
        StandardWriting : int * 
        StandardMath : int * 
        StandardScience : int * 
        StandardSocial : int * 
        CollegeBound : bool * 
        Race : string * 
        Lunch : string * 
        EnglishLangLearner : string * 
        ActionData : string -> ApiResults 
override UpdateStudent : 
        apiUsername : string * 
        apiPassword : string * 
        StudentExternalID : string * 
        FirstName : string * 
        MiddleName : string * 
        LastName : string * 
        RequestedUsername : string * 
        Password : string * 
        Email : string * 
        StreetAddress : string * 
        City : string * 
        PostalCode : string * 
        State : string * 
        HomePhone : string * 
        AltPhone : string * 
        ComputerPhone : string * 
        GradeLevel : int * 
        BirthDate : DateTime * 
        StudentGender : Gender * 
        StartDate : DateTime * 
        Notes : string * 
        Status : int * 
        ShowEReader : bool * 
        ForceOrientation : bool * 
        StandardReadering : int * 
        StandardWriting : int * 
        StandardMath : int * 
        StandardScience : int * 
        StandardSocial : int * 
        CollegeBound : bool * 
        Race : string * 
        Lunch : string * 
        EnglishLangLearner : string * 
        ActionData : string -> ApiResults

Parameters

apiUsername: Type: SystemString
Username of the API user
apiPassword: Type: SystemString
Password of the APU user
StudentExternalID: Type: SystemString
Unique ID used to identify the student in your system
FirstName: Type: SystemString
Students first name
MiddleName: Type: SystemString
Students middle name
LastName: Type: SystemString
Students last name
RequestedUsername: Type: SystemString
Student's e2020 username
Password: Type: SystemString
Student's password
Email: Type: SystemString
Students email address
StreetAddress: Type: SystemString
Students street address
City: Type: SystemString
Students city
PostalCode: Type: SystemString
Students zip code
State: Type: SystemString
Students state
HomePhone: Type: SystemString
Students home phone number
AltPhone: Type: SystemString
Students alternative phone number
ComputerPhone: Type: SystemString
[Missing <param name="ComputerPhone"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
GradeLevel: Type: SystemInt32
Stuents grade
BirthDate: Type: SystemDateTime
Students borth date
StudentGender: Type: EnumerationsGender
Students gender
StartDate: Type: SystemDateTime
Students start date
Notes: Type: SystemString
Any misc notes for this Student
Status: Type: SystemInt32
Recognized statuses (2 and 100 being the most common): 1 = Active 2 - Enrolled 100 - Disabled 104 - Expelled 103 - Dropped 102 - Pending 105 - Graduated 106 - Not Enrolling
ShowEReader: Type: SystemBoolean
Show the accessibility readefr for this student
ForceOrientation: Type: SystemBoolean
Show Orientation videos upon first sign in for this student
StandardReadering: Type: SystemInt32
[Missing <param name="StandardReadering"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
StandardWriting: Type: SystemInt32
[Missing <param name="StandardWriting"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
StandardMath: Type: SystemInt32
[Missing <param name="StandardMath"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
StandardScience: Type: SystemInt32
[Missing <param name="StandardScience"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
StandardSocial: Type: SystemInt32
[Missing <param name="StandardSocial"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
CollegeBound: Type: SystemBoolean
Is the student bound for college
Race: Type: SystemString
[Missing <param name="Race"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
Lunch: Type: SystemString
[Missing <param name="Lunch"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
EnglishLangLearner: Type: SystemString
[Missing <param name="EnglishLangLearner"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]
ActionData: Type: SystemString
[Missing <param name="ActionData"/> documentation for "M:WCFAPI.E2020API.UpdateStudent(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.Int32,System.DateTime,Enumerations.Gender,System.DateTime,System.String,System.Int32,System.Boolean,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean,System.String,System.String,System.String,System.String)"]

Return Value

Type: ApiResults
Success/fail status message

Reference

E2020API Class

WCFAPI Namespace