C# Class RicOneApi.Api.XPress

Static class built off of RICOne client to allow access to xPress data model objects

Datei anzeigen Open project: RIConeorg/API-ClientLibrary-DotNet Class Usage Examples

Public Methods

Method	Description
CreateXStaffUsers ( string refId ) : ResponseMulti	Create staff usernames and passwords by school
CreateXStudentUsers ( string refId ) : ResponseMulti	Create student usernames and passwords by school
DeleteXStaffUsers ( string refId ) : ResponseMulti	Delete generated staff passwords by school
DeleteXStudentUsers ( string refId ) : ResponseMulti	Delete generated student passwords by school
GetLastPage ( int navigationPageSize, ServicePath p ) : int	Max page value for specified service path object
GetLastPage ( int navigationPageSize, ServicePath p, string refId ) : int	Max page value for specified service path object
GetXCalendar ( string refId ) : ResponseSingle	Request single Calendar by refId
GetXCalendar ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Calendar by refId
GetXCalendars ( ) : ResponseMulti	Request all Calendars
GetXCalendars ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Calendars
GetXCalendarsByXLea ( string refId ) : ResponseMulti	Returns Calendars associated to a specific Lea by refId
GetXCalendarsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Calendars associated to a specific Lea by refId
GetXCalendarsByXSchool ( string refId ) : ResponseMulti	Returns Calendars associated to a specific School by refId
GetXCalendarsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Calendars associated to a specific School by refId
GetXContact ( string refId ) : ResponseSingle	Request single Contact by refId
GetXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Contact by refId
GetXContacts ( ) : ResponseMulti	Request all Contacts
GetXContacts ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Contacts
GetXContactsByXLea ( string refId ) : ResponseMulti	Returns Contacts associated to a specific Lea by refId
GetXContactsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Contacts associated to a specific Lea by refId
GetXContactsByXSchool ( string refId ) : ResponseMulti	Returns Contacts associated to a specific School by refId
GetXContactsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Contacts associated to a specific School by refId
GetXContactsByXStudent ( string refId ) : ResponseMulti	Returns Contacts associated to a specific Student by refId
GetXContactsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Contacts associated to a specific Student by refId
GetXCourse ( string refId ) : ResponseSingle	Request single Course by refId
GetXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Course by refId
GetXCourses ( ) : ResponseMulti	Request all Courses
GetXCourses ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Courses
GetXCoursesByXLea ( string refId ) : ResponseMulti	Returns Courses associated to a specific Lea by refId
GetXCoursesByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Courses associated to a specific Lea by refId
GetXCoursesByXRoster ( string refId ) : ResponseMulti	Returns Courses associated to a specific Roster by refId
GetXCoursesByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Courses associated to a specific Roster by refId
GetXCoursesByXSchool ( string refId ) : ResponseMulti	Returns Courses associated to a specific School by refId
GetXCoursesByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Courses associated to a specific School by refId
GetXLea ( string refId ) : ResponseSingle	Request single Leas by refId
GetXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Leas by refId
GetXLeas ( ) : ResponseMulti	Request all Leas
GetXLeas ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Leas
GetXLeasByXContact ( string refId ) : ResponseMulti	Returns Leas associated to a specific Contact by refId
GetXLeasByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Leas associated to a specific Contact by refId
GetXLeasByXRoster ( string refId ) : ResponseMulti	Returns Leas associated to a specific Roster by refId
GetXLeasByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Leas associated to a specific Roster by refId
GetXLeasByXSchool ( string refId ) : ResponseMulti	Returns Leas associated to a specific School by refId
GetXLeasByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Leas associated to a specific School by refId
GetXLeasByXStaff ( string refId ) : ResponseMulti	Returns Leas associated to a specific Staff by refId
GetXLeasByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Leas associated to a specific Staff by refId
GetXLeasByXStudent ( string refId ) : ResponseMulti	Returns Leas associated to a specific Student by refId
GetXLeasByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Leas associated to a specific Student by refId
GetXRoster ( string refId ) : ResponseSingle	Request single Roster by refId
GetXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Roster by refId
GetXRosters ( ) : ResponseMulti	Request all Rosters
GetXRosters ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Rosters
GetXRostersByXCourse ( string refId ) : ResponseMulti	Returns Rosters associated to a specific Course by refId
GetXRostersByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Rosters associated to a specific Course by refId
GetXRostersByXLea ( string refId ) : ResponseMulti	Returns Rosters associated to a specific Lea by refId
GetXRostersByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Rosters associated to a specific Lea by refId
GetXRostersByXSchool ( string refId ) : ResponseMulti	Returns Rosters associated to a specific School by refId
GetXRostersByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Rosters associated to a specific School by refId
GetXRostersByXStaff ( string refId ) : ResponseMulti	Returns Rosters associated to a specific Staff by refId
GetXRostersByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Rosters associated to a specific Staff by refId
GetXRostersByXStudent ( string refId ) : ResponseMulti	Returns Rosters associated to a specific Student by refId
GetXRostersByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Rosters associated to a specific Student by refId
GetXSchool ( string refId ) : ResponseSingle	Request single School by refId
GetXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single School by refId
GetXSchools ( ) : ResponseMulti	Request all Schools
GetXSchools ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Schools
GetXSchoolsByXCalendar ( string refId ) : ResponseMulti	Returns Schools associated to a specific Calendar by refId
GetXSchoolsByXCalendar ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Calendar by refId
GetXSchoolsByXContact ( string refId ) : ResponseMulti	Returns Schools associated to a specific Contact by refId
GetXSchoolsByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Contact by refId
GetXSchoolsByXCourse ( string refId ) : ResponseMulti	Returns Schools associated to a specific Course by refId
GetXSchoolsByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Course by refId
GetXSchoolsByXLea ( string refId ) : ResponseMulti	Returns Schools associated to a specific Lea by refId
GetXSchoolsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Lea by refId
GetXSchoolsByXRoster ( string refId ) : ResponseMulti	Returns Schools associated to a specific Roster by refId
GetXSchoolsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Roster by refId
GetXSchoolsByXStaff ( string refId ) : ResponseMulti	Returns Schools associated to a specific Staff by refId
GetXSchoolsByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Staff by refId
GetXSchoolsByXStudent ( string refId ) : ResponseMulti	Returns Schools associated to a specific Student by refId
GetXSchoolsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Schools associated to a specific Student by refId
GetXStaff ( string refId ) : ResponseSingle	Request single Staffs by refId
GetXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Staffs by refId
GetXStaffUsers ( string refId ) : ResponseMulti	Return generated staff usernames and passwords by school
GetXStaffs ( ) : ResponseMulti	Request all Staffs
GetXStaffs ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Staffs
GetXStaffsByXCourse ( string refId ) : ResponseMulti	Returns Staffs associated to a specific Course by refId
GetXStaffsByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Staffs associated to a specific Course by refId
GetXStaffsByXLea ( string refId ) : ResponseMulti	Returns Staffs associated to a specific Lea by refId
GetXStaffsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Staffs associated to a specific Lea by refId
GetXStaffsByXRoster ( string refId ) : ResponseMulti	Returns Staffs associated to a specific Roster by refId
GetXStaffsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Staffs associated to a specific Roster by refId
GetXStaffsByXSchool ( string refId ) : ResponseMulti	Returns Staffs associated to a specific School by refId
GetXStaffsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Staffs associated to a specific School by refId
GetXStaffsByXStudent ( string refId ) : ResponseMulti	Returns Staffs associated to a specific Student by refId
GetXStaffsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Staffs associated to a specific Student by refId
GetXStudent ( string refId ) : ResponseSingle	Request single Student by refId
GetXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle	Request single Student by refId
GetXStudentUsers ( string refId ) : ResponseMulti	Return generated student usernames and passwords by school
GetXStudents ( ) : ResponseMulti	Request all Students
GetXStudents ( int navigationPage, int navigationPageSize ) : ResponseMulti	Request all Students
GetXStudentsByXContact ( string refId ) : ResponseMulti	Returns Students associated to a specific Contact by refId
GetXStudentsByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Students associated to a specific Contact by refId
GetXStudentsByXLea ( string refId ) : ResponseMulti	Returns Students associated to a specific Lea by refId
GetXStudentsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Students associated to a specific Lea by refId
GetXStudentsByXRoster ( string refId ) : ResponseMulti	Returns Students associated to a specific Roster by refId
GetXStudentsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Students associated to a specific Roster by refId
GetXStudentsByXSchool ( string refId ) : ResponseMulti	Returns Students associated to a specific School by refId
GetXStudentsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Students associated to a specific School by refId
GetXStudentsByXStaff ( string refId ) : ResponseMulti	Returns Students associated to a specific Staff by refId
GetXStudentsByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti	Returns Students associated to a specific Staff by refId
XPress ( string baseApiUrl ) : System

Private Methods

Method	Description
CreateXContactUsers ( string refId ) : ResponseMulti	Create contact usernames and passwords by school
DeleteXContactUsers ( string refId ) : ResponseMulti	Delete generated contact passwords by school
GetXContactUsers ( string refId ) : ResponseMulti	Return generated contact usernames and passwords by school

Method Details

CreateXStaffUsers() public method

Create staff usernames and passwords by school

public CreateXStaffUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

CreateXStudentUsers() public method

Create student usernames and passwords by school

public CreateXStudentUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

DeleteXStaffUsers() public method

Delete generated staff passwords by school

public DeleteXStaffUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

DeleteXStudentUsers() public method

Delete generated student passwords by school

public DeleteXStudentUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetLastPage() public method

Max page value for specified service path object

public GetLastPage ( int navigationPageSize, ServicePath p ) : int
navigationPageSize	int
p	ServicePath
return	int

GetLastPage() public method

Max page value for specified service path object

public GetLastPage ( int navigationPageSize, ServicePath p, string refId ) : int
navigationPageSize	int
p	ServicePath
refId	string
return	int

GetXCalendar() public method

Request single Calendar by refId

public GetXCalendar ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXCalendar() public method

Request single Calendar by refId

public GetXCalendar ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXCalendars() public method

Request all Calendars

public GetXCalendars ( ) : ResponseMulti
return	ResponseMulti

GetXCalendars() public method

Request all Calendars

public GetXCalendars ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCalendarsByXLea() public method

Returns Calendars associated to a specific Lea by refId

public GetXCalendarsByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXCalendarsByXLea() public method

Returns Calendars associated to a specific Lea by refId

public GetXCalendarsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCalendarsByXSchool() public method

Returns Calendars associated to a specific School by refId

public GetXCalendarsByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXCalendarsByXSchool() public method

Returns Calendars associated to a specific School by refId

public GetXCalendarsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXContact() public method

Request single Contact by refId

public GetXContact ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXContact() public method

Request single Contact by refId

public GetXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXContacts() public method

Request all Contacts

public GetXContacts ( ) : ResponseMulti
return	ResponseMulti

GetXContacts() public method

Request all Contacts

public GetXContacts ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXContactsByXLea() public method

Returns Contacts associated to a specific Lea by refId

public GetXContactsByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXContactsByXLea() public method

Returns Contacts associated to a specific Lea by refId

public GetXContactsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXContactsByXSchool() public method

Returns Contacts associated to a specific School by refId

public GetXContactsByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXContactsByXSchool() public method

Returns Contacts associated to a specific School by refId

public GetXContactsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXContactsByXStudent() public method

Returns Contacts associated to a specific Student by refId

public GetXContactsByXStudent ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXContactsByXStudent() public method

Returns Contacts associated to a specific Student by refId

public GetXContactsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCourse() public method

Request single Course by refId

public GetXCourse ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXCourse() public method

Request single Course by refId

public GetXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXCourses() public method

Request all Courses

public GetXCourses ( ) : ResponseMulti
return	ResponseMulti

GetXCourses() public method

Request all Courses

public GetXCourses ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCoursesByXLea() public method

Returns Courses associated to a specific Lea by refId

public GetXCoursesByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXCoursesByXLea() public method

Returns Courses associated to a specific Lea by refId

public GetXCoursesByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCoursesByXRoster() public method

Returns Courses associated to a specific Roster by refId

public GetXCoursesByXRoster ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXCoursesByXRoster() public method

Returns Courses associated to a specific Roster by refId

public GetXCoursesByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXCoursesByXSchool() public method

Returns Courses associated to a specific School by refId

public GetXCoursesByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXCoursesByXSchool() public method

Returns Courses associated to a specific School by refId

public GetXCoursesByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLea() public method

Request single Leas by refId

public GetXLea ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXLea() public method

Request single Leas by refId

public GetXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXLeas() public method

Request all Leas

public GetXLeas ( ) : ResponseMulti
return	ResponseMulti

GetXLeas() public method

Request all Leas

public GetXLeas ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLeasByXContact() public method

Returns Leas associated to a specific Contact by refId

public GetXLeasByXContact ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXLeasByXContact() public method

Returns Leas associated to a specific Contact by refId

public GetXLeasByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLeasByXRoster() public method

Returns Leas associated to a specific Roster by refId

public GetXLeasByXRoster ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXLeasByXRoster() public method

Returns Leas associated to a specific Roster by refId

public GetXLeasByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLeasByXSchool() public method

Returns Leas associated to a specific School by refId

public GetXLeasByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXLeasByXSchool() public method

Returns Leas associated to a specific School by refId

public GetXLeasByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLeasByXStaff() public method

Returns Leas associated to a specific Staff by refId

public GetXLeasByXStaff ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXLeasByXStaff() public method

Returns Leas associated to a specific Staff by refId

public GetXLeasByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXLeasByXStudent() public method

Returns Leas associated to a specific Student by refId

public GetXLeasByXStudent ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXLeasByXStudent() public method

Returns Leas associated to a specific Student by refId

public GetXLeasByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRoster() public method

Request single Roster by refId

public GetXRoster ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXRoster() public method

Request single Roster by refId

public GetXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXRosters() public method

Request all Rosters

public GetXRosters ( ) : ResponseMulti
return	ResponseMulti

GetXRosters() public method

Request all Rosters

public GetXRosters ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRostersByXCourse() public method

Returns Rosters associated to a specific Course by refId

public GetXRostersByXCourse ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXRostersByXCourse() public method

Returns Rosters associated to a specific Course by refId

public GetXRostersByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRostersByXLea() public method

Returns Rosters associated to a specific Lea by refId

public GetXRostersByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXRostersByXLea() public method

Returns Rosters associated to a specific Lea by refId

public GetXRostersByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRostersByXSchool() public method

Returns Rosters associated to a specific School by refId

public GetXRostersByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXRostersByXSchool() public method

Returns Rosters associated to a specific School by refId

public GetXRostersByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRostersByXStaff() public method

Returns Rosters associated to a specific Staff by refId

public GetXRostersByXStaff ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXRostersByXStaff() public method

Returns Rosters associated to a specific Staff by refId

public GetXRostersByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXRostersByXStudent() public method

Returns Rosters associated to a specific Student by refId

public GetXRostersByXStudent ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXRostersByXStudent() public method

Returns Rosters associated to a specific Student by refId

public GetXRostersByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchool() public method

Request single School by refId

public GetXSchool ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXSchool() public method

Request single School by refId

public GetXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXSchools() public method

Request all Schools

public GetXSchools ( ) : ResponseMulti
return	ResponseMulti

GetXSchools() public method

Request all Schools

public GetXSchools ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXCalendar() public method

Returns Schools associated to a specific Calendar by refId

public GetXSchoolsByXCalendar ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXCalendar() public method

Returns Schools associated to a specific Calendar by refId

public GetXSchoolsByXCalendar ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXContact() public method

Returns Schools associated to a specific Contact by refId

public GetXSchoolsByXContact ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXContact() public method

Returns Schools associated to a specific Contact by refId

public GetXSchoolsByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXCourse() public method

Returns Schools associated to a specific Course by refId

public GetXSchoolsByXCourse ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXCourse() public method

Returns Schools associated to a specific Course by refId

public GetXSchoolsByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXLea() public method

Returns Schools associated to a specific Lea by refId

public GetXSchoolsByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXLea() public method

Returns Schools associated to a specific Lea by refId

public GetXSchoolsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXRoster() public method

Returns Schools associated to a specific Roster by refId

public GetXSchoolsByXRoster ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXRoster() public method

Returns Schools associated to a specific Roster by refId

public GetXSchoolsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXStaff() public method

Returns Schools associated to a specific Staff by refId

public GetXSchoolsByXStaff ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXStaff() public method

Returns Schools associated to a specific Staff by refId

public GetXSchoolsByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXSchoolsByXStudent() public method

Returns Schools associated to a specific Student by refId

public GetXSchoolsByXStudent ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXSchoolsByXStudent() public method

Returns Schools associated to a specific Student by refId

public GetXSchoolsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaff() public method

Request single Staffs by refId

public GetXStaff ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXStaff() public method

Request single Staffs by refId

public GetXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXStaffUsers() public method

Return generated staff usernames and passwords by school

public GetXStaffUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffs() public method

Request all Staffs

public GetXStaffs ( ) : ResponseMulti
return	ResponseMulti

GetXStaffs() public method

Request all Staffs

public GetXStaffs ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaffsByXCourse() public method

Returns Staffs associated to a specific Course by refId

public GetXStaffsByXCourse ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffsByXCourse() public method

Returns Staffs associated to a specific Course by refId

public GetXStaffsByXCourse ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaffsByXLea() public method

Returns Staffs associated to a specific Lea by refId

public GetXStaffsByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffsByXLea() public method

Returns Staffs associated to a specific Lea by refId

public GetXStaffsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaffsByXRoster() public method

Returns Staffs associated to a specific Roster by refId

public GetXStaffsByXRoster ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffsByXRoster() public method

Returns Staffs associated to a specific Roster by refId

public GetXStaffsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaffsByXSchool() public method

Returns Staffs associated to a specific School by refId

public GetXStaffsByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffsByXSchool() public method

Returns Staffs associated to a specific School by refId

public GetXStaffsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStaffsByXStudent() public method

Returns Staffs associated to a specific Student by refId

public GetXStaffsByXStudent ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStaffsByXStudent() public method

Returns Staffs associated to a specific Student by refId

public GetXStaffsByXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudent() public method

Request single Student by refId

public GetXStudent ( string refId ) : ResponseSingle
refId	string
return	ResponseSingle

GetXStudent() public method

Request single Student by refId

public GetXStudent ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseSingle

GetXStudentUsers() public method

Return generated student usernames and passwords by school

public GetXStudentUsers ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudents() public method

Request all Students

public GetXStudents ( ) : ResponseMulti
return	ResponseMulti

GetXStudents() public method

Request all Students

public GetXStudents ( int navigationPage, int navigationPageSize ) : ResponseMulti
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudentsByXContact() public method

Returns Students associated to a specific Contact by refId

public GetXStudentsByXContact ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudentsByXContact() public method

Returns Students associated to a specific Contact by refId

public GetXStudentsByXContact ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudentsByXLea() public method

Returns Students associated to a specific Lea by refId

public GetXStudentsByXLea ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudentsByXLea() public method

Returns Students associated to a specific Lea by refId

public GetXStudentsByXLea ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudentsByXRoster() public method

Returns Students associated to a specific Roster by refId

public GetXStudentsByXRoster ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudentsByXRoster() public method

Returns Students associated to a specific Roster by refId

public GetXStudentsByXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudentsByXSchool() public method

Returns Students associated to a specific School by refId

public GetXStudentsByXSchool ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudentsByXSchool() public method

Returns Students associated to a specific School by refId

public GetXStudentsByXSchool ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

GetXStudentsByXStaff() public method

Returns Students associated to a specific Staff by refId

public GetXStudentsByXStaff ( string refId ) : ResponseMulti
refId	string
return	ResponseMulti

GetXStudentsByXStaff() public method

Returns Students associated to a specific Staff by refId

public GetXStudentsByXStaff ( string refId, int navigationPage, int navigationPageSize ) : ResponseMulti
refId	string
navigationPage	int
navigationPageSize	int
return	ResponseMulti

XPress() public method

public XPress ( string baseApiUrl ) : System
baseApiUrl	string
return	System