UsersUpdateUserSchool Method A Sandcastle Documented Class Library
Update a user's school

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

public ApiResults UpdateUserSchool(
	string apiUsername,
	string apiPassword,
	string UserExternalID,
	string SchoolExternalID,
	SchoolType Type
)

Parameters

apiUsername
Type: SystemString
API Username
apiPassword
Type: SystemString
API Password
UserExternalID
Type: SystemString
External ID of the user to move
SchoolExternalID
Type: SystemString
External ID of the new school
Type
Type: EnumerationsSchoolType
Whether to add an access school or move to a new home school

Return Value

Type: ApiResults
Success/fail status message
See Also

Reference