RicOneApi.Api.XPress.GetXRoster C# (CSharp) Method

GetXRoster() public method

Request single Roster by refId
public GetXRoster ( string refId ) : ResponseSingle
refId string
return ResponseSingle
        public ResponseSingle<XRosterType> GetXRoster(string refId)
        {
            ResponseSingle<XRosterType> output = new ResponseSingle<XRosterType>();

            RestRequest request = new RestRequest("xRosters/{refId}", Method.GET);
            request.AddParameter("refId", refId, ParameterType.UrlSegment);
            request.AddHeader("Accept", "application/json");

            var response = restClient.Execute<XRosterCollectionType>(request);

            try
            {
                output.Data = response.Data.xRoster.First();
                output.StatusCode = (int)response.StatusCode;
                output.Message = response.StatusDescription;
                output.Header = Util.BuildHeader(response);
            }
            catch (Exception)
            {
                output.Data = null;
                output.StatusCode = (int)response.StatusCode;
                output.Message = response.StatusDescription;
                output.Header = Util.BuildHeader(response);
            }

            return output;
        }

Same methods

XPress::GetXRoster ( string refId, int navigationPage, int navigationPageSize ) : ResponseSingle

Usage Example

        //RETURN SINGLE ROSTER
        public static void XRosters_GetXRoster(XPress xPress)
        {
            if(xPress.GetXRoster(refId).Data != null)
            {
                XRosterType r = xPress.GetXRoster(refId).Data;

                Console.WriteLine("refId: " + r.refId);
                Console.WriteLine("courseRefId: " + r.courseRefId);
                Console.WriteLine("courseTitle: " + r.courseTitle);
                Console.WriteLine("sectionRefId: " + r.sectionRefId);
                Console.WriteLine("subject: " + r.subject);
                Console.WriteLine("schoolRefId: " + r.schoolRefId);
                Console.WriteLine("schoolSectionId: " + r.schoolSectionId);
                Console.WriteLine("schoolYear: " + r.schoolYear);
                Console.WriteLine("sessionCode: " + r.sessionCode);
                Console.WriteLine("schoolCalendarRefId: " + r.schoolCalendarRefId);

                Console.WriteLine("##### BEGIN MEETING TIMES #####");
                foreach (XMeetingTimeType mt in r.meetingTimes.meetingTime)
                {
                    Console.WriteLine("timeTableDay: " + mt.timeTableDay);

                    Console.WriteLine("bellScheduleDay: " + mt.classMeetingDays.bellScheduleDay);
                    Console.WriteLine("timeTablePeriod: " + mt.timeTablePeriod);
                    Console.WriteLine("roomNumber: " + mt.roomNumber);
                    Console.WriteLine("classBeginningTime: " + mt.classBeginningTime);
                    Console.WriteLine("classEndingTime: " + mt.classEndingTime);
                }
                Console.WriteLine("##### END MEETING TIMES #####");

                Console.WriteLine("##### BEGIN STUDENTS #####");
                foreach (XPersonReferenceType student in r.students.studentReference)
                {
                    Console.WriteLine("refId: " + student.refId);
                    Console.WriteLine("localId: " + student.localId);
                    Console.WriteLine("givenName: " + student.givenName);
                    Console.WriteLine("familyName: " + student.familyName);
                }
                Console.WriteLine("##### END STUDENTS #####");

                Console.WriteLine("##### BEGIN PRIMARY STAFF #####");
                Console.WriteLine("refId: " + r.primaryStaff.staffPersonReference.refId);
                Console.WriteLine("localId: " + r.primaryStaff.staffPersonReference.localId);
                Console.WriteLine("givenName: " + r.primaryStaff.staffPersonReference.givenName);
                Console.WriteLine("familyName: " + r.primaryStaff.staffPersonReference.familyName);
                Console.WriteLine("teacherOfRecord: " + r.primaryStaff.teacherOfRecord);
                Console.WriteLine("percentResponsible: " + r.primaryStaff.percentResponsible);
                Console.WriteLine("##### END PRIMARY STAFF #####");

                Console.WriteLine("##### BEGIN OTHER STAFF #####");
                foreach (XStaffReferenceType staff in r.otherStaffs.otherStaff)
                {
                    Console.WriteLine("refId: " + staff.staffPersonReference.refId);
                    Console.WriteLine("localId: " + staff.staffPersonReference.localId);
                    Console.WriteLine("givenName: " + staff.staffPersonReference.givenName);
                    Console.WriteLine("familyName: " + staff.staffPersonReference.familyName);
                    Console.WriteLine("teacherOfRecord: " + staff.teacherOfRecord);
                    Console.WriteLine("percentResponsible: " + staff.percentResponsible);
                }
                Console.WriteLine("##### END OTHER STAFF #####");
                Console.WriteLine("========================================");
            }
        }