AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

GetClassGradebookData

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.Achademix.com/GetClassGradebookData"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <GetClassGradebookData xmlns="http://www.Achademix.com/">
      <ClassID>int</ClassID>
      <LoadStudents>boolean</LoadStudents>
    </GetClassGradebookData>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap:Header>
  <soap:Body>
    <GetClassGradebookDataResponse xmlns="http://www.Achademix.com/">
      <GetClassGradebookDataResult>
        <ActiveEnrolledStudents>
          <ClassStudent>
            <Class xsi:nil="true" />
            <ClassBalance>string</ClassBalance>
            <PathTitle>string</PathTitle>
            <ScheduleTitle>string</ScheduleTitle>
            <ClassGrades xsi:nil="true" />
            <StatusTitle>string</StatusTitle>
            <StatusDate>dateTime</StatusDate>
            <Student xsi:nil="true" />
            <StudentCode>string</StudentCode>
            <StudentName>string</StudentName>
            <StudentType>int</StudentType>
            <UICommands>string</UICommands>
            <OsHrTypeCode>string</OsHrTypeCode>
            <OsHrTypeTitle>string</OsHrTypeTitle>
            <AssociationID>int</AssociationID>
            <AttUpdate>dateTime</AttUpdate>
            <ClassID>int</ClassID>
            <ClassStudentID>int</ClassStudentID>
            <AbsentDays>int</AbsentDays>
            <AbsentTimeMin>int</AbsentTimeMin>
            <AutoLDA>boolean</AutoLDA>
            <Credits>decimal</Credits>
            <Dismissed>boolean</Dismissed>
            <EntryDate>dateTime</EntryDate>
            <ExcusedDays>int</ExcusedDays>
            <ExcusedTimeMin>int</ExcusedTimeMin>
            <ExitDate>dateTime</ExitDate>
            <ClsStuExitListID>int</ClsStuExitListID>
            <FinalizeDate>dateTime</FinalizeDate>
            <FirstEnroll>boolean</FirstEnroll>
            <Hours>decimal</Hours>
            <NoPathID>int</NoPathID>
            <NoTrans>boolean</NoTrans>
            <OnWaitList>boolean</OnWaitList>
            <OSHours>decimal</OSHours>
            <OSHourType>string</OSHourType>
            <PathStudentID>int</PathStudentID>
            <WaitDate>dateTime</WaitDate>
            <Weeks>int</Weeks>
            <ImportKey>int</ImportKey>
            <LastDateAttend>dateTime</LastDateAttend>
            <LetterGrade>string</LetterGrade>
            <License>string</License>
            <MakeupDays>int</MakeupDays>
            <MakeupTimeMin>int</MakeupTimeMin>
            <NumberGrade>decimal</NumberGrade>
            <PossibleDays>int</PossibleDays>
            <PossibleTimeMin>int</PossibleTimeMin>
            <PresentDays>int</PresentDays>
            <PresentTimeMin>int</PresentTimeMin>
            <RegDate>dateTime</RegDate>
            <ClsStuStatusID>int</ClsStuStatusID>
            <TardyDays>int</TardyDays>
            <TardyTimeMin>int</TardyTimeMin>
            <TransferSchool>string</TransferSchool>
            <ClsStuTypeListID>int</ClsStuTypeListID>
            <UserData>string</UserData>
            <GradeLevelListID>int</GradeLevelListID>
            <StudentID>int</StudentID>
            <ClassEventID>int</ClassEventID>
            <Note>string</Note>
            <ClassGroupID>int</ClassGroupID>
            <ClsStuOSHrTypeListID>int</ClsStuOSHrTypeListID>
            <AbsentPolicyCnt>int</AbsentPolicyCnt>
            <TardyPolicyCnt>int</TardyPolicyCnt>
          </ClassStudent>
          <ClassStudent>
            <Class xsi:nil="true" />
            <ClassBalance>string</ClassBalance>
            <PathTitle>string</PathTitle>
            <ScheduleTitle>string</ScheduleTitle>
            <ClassGrades xsi:nil="true" />
            <StatusTitle>string</StatusTitle>
            <StatusDate>dateTime</StatusDate>
            <Student xsi:nil="true" />
            <StudentCode>string</StudentCode>
            <StudentName>string</StudentName>
            <StudentType>int</StudentType>
            <UICommands>string</UICommands>
            <OsHrTypeCode>string</OsHrTypeCode>
            <OsHrTypeTitle>string</OsHrTypeTitle>
            <AssociationID>int</AssociationID>
            <AttUpdate>dateTime</AttUpdate>
            <ClassID>int</ClassID>
            <ClassStudentID>int</ClassStudentID>
            <AbsentDays>int</AbsentDays>
            <AbsentTimeMin>int</AbsentTimeMin>
            <AutoLDA>boolean</AutoLDA>
            <Credits>decimal</Credits>
            <Dismissed>boolean</Dismissed>
            <EntryDate>dateTime</EntryDate>
            <ExcusedDays>int</ExcusedDays>
            <ExcusedTimeMin>int</ExcusedTimeMin>
            <ExitDate>dateTime</ExitDate>
            <ClsStuExitListID>int</ClsStuExitListID>
            <FinalizeDate>dateTime</FinalizeDate>
            <FirstEnroll>boolean</FirstEnroll>
            <Hours>decimal</Hours>
            <NoPathID>int</NoPathID>
            <NoTrans>boolean</NoTrans>
            <OnWaitList>boolean</OnWaitList>
            <OSHours>decimal</OSHours>
            <OSHourType>string</OSHourType>
            <PathStudentID>int</PathStudentID>
            <WaitDate>dateTime</WaitDate>
            <Weeks>int</Weeks>
            <ImportKey>int</ImportKey>
            <LastDateAttend>dateTime</LastDateAttend>
            <LetterGrade>string</LetterGrade>
            <License>string</License>
            <MakeupDays>int</MakeupDays>
            <MakeupTimeMin>int</MakeupTimeMin>
            <NumberGrade>decimal</NumberGrade>
            <PossibleDays>int</PossibleDays>
            <PossibleTimeMin>int</PossibleTimeMin>
            <PresentDays>int</PresentDays>
            <PresentTimeMin>int</PresentTimeMin>
            <RegDate>dateTime</RegDate>
            <ClsStuStatusID>int</ClsStuStatusID>
            <TardyDays>int</TardyDays>
            <TardyTimeMin>int</TardyTimeMin>
            <TransferSchool>string</TransferSchool>
            <ClsStuTypeListID>int</ClsStuTypeListID>
            <UserData>string</UserData>
            <GradeLevelListID>int</GradeLevelListID>
            <StudentID>int</StudentID>
            <ClassEventID>int</ClassEventID>
            <Note>string</Note>
            <ClassGroupID>int</ClassGroupID>
            <ClsStuOSHrTypeListID>int</ClsStuOSHrTypeListID>
            <AbsentPolicyCnt>int</AbsentPolicyCnt>
            <TardyPolicyCnt>int</TardyPolicyCnt>
          </ClassStudent>
        </ActiveEnrolledStudents>
        <ClassGradeActivities>
          <ClassActivity>
            <Activity xsi:nil="true" />
            <GroupActivities xsi:nil="true" />
            <ClassActivityID>int</ClassActivityID>
            <ClassID>int</ClassID>
            <GradeActivityID>int</GradeActivityID>
            <ImportKey>int</ImportKey>
          </ClassActivity>
          <ClassActivity>
            <Activity xsi:nil="true" />
            <GroupActivities xsi:nil="true" />
            <ClassActivityID>int</ClassActivityID>
            <ClassID>int</ClassID>
            <GradeActivityID>int</GradeActivityID>
            <ImportKey>int</ImportKey>
          </ClassActivity>
        </ClassGradeActivities>
        <ClassGroups>
          <ClassGroup>
            <GroupActivities xsi:nil="true" />
            <GroupGradeScale xsi:nil="true" />
            <ClassGroupID>int</ClassGroupID>
            <ClassID>int</ClassID>
            <Code>string</Code>
            <GradeScaleID>int</GradeScaleID>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </ClassGroup>
          <ClassGroup>
            <GroupActivities xsi:nil="true" />
            <GroupGradeScale xsi:nil="true" />
            <ClassGroupID>int</ClassGroupID>
            <ClassID>int</ClassID>
            <Code>string</Code>
            <GradeScaleID>int</GradeScaleID>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </ClassGroup>
        </ClassGroups>
        <ClassID>int</ClassID>
      </GetClassGradebookDataResult>
    </GetClassGradebookDataResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AxWCC1474WS/AchademixWS.asmx HTTP/1.1
Host: wcccws.achademix.info
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <GetClassGradebookData xmlns="http://www.Achademix.com/">
      <ClassID>int</ClassID>
      <LoadStudents>boolean</LoadStudents>
    </GetClassGradebookData>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AchademixHeader xmlns="http://www.Achademix.com/">
      <AuthenticationID>string</AuthenticationID>
      <ErrorDetails>string</ErrorDetails>
      <ErrorMessage>string</ErrorMessage>
    </AchademixHeader>
  </soap12:Header>
  <soap12:Body>
    <GetClassGradebookDataResponse xmlns="http://www.Achademix.com/">
      <GetClassGradebookDataResult>
        <ActiveEnrolledStudents>
          <ClassStudent>
            <Class xsi:nil="true" />
            <ClassBalance>string</ClassBalance>
            <PathTitle>string</PathTitle>
            <ScheduleTitle>string</ScheduleTitle>
            <ClassGrades xsi:nil="true" />
            <StatusTitle>string</StatusTitle>
            <StatusDate>dateTime</StatusDate>
            <Student xsi:nil="true" />
            <StudentCode>string</StudentCode>
            <StudentName>string</StudentName>
            <StudentType>int</StudentType>
            <UICommands>string</UICommands>
            <OsHrTypeCode>string</OsHrTypeCode>
            <OsHrTypeTitle>string</OsHrTypeTitle>
            <AssociationID>int</AssociationID>
            <AttUpdate>dateTime</AttUpdate>
            <ClassID>int</ClassID>
            <ClassStudentID>int</ClassStudentID>
            <AbsentDays>int</AbsentDays>
            <AbsentTimeMin>int</AbsentTimeMin>
            <AutoLDA>boolean</AutoLDA>
            <Credits>decimal</Credits>
            <Dismissed>boolean</Dismissed>
            <EntryDate>dateTime</EntryDate>
            <ExcusedDays>int</ExcusedDays>
            <ExcusedTimeMin>int</ExcusedTimeMin>
            <ExitDate>dateTime</ExitDate>
            <ClsStuExitListID>int</ClsStuExitListID>
            <FinalizeDate>dateTime</FinalizeDate>
            <FirstEnroll>boolean</FirstEnroll>
            <Hours>decimal</Hours>
            <NoPathID>int</NoPathID>
            <NoTrans>boolean</NoTrans>
            <OnWaitList>boolean</OnWaitList>
            <OSHours>decimal</OSHours>
            <OSHourType>string</OSHourType>
            <PathStudentID>int</PathStudentID>
            <WaitDate>dateTime</WaitDate>
            <Weeks>int</Weeks>
            <ImportKey>int</ImportKey>
            <LastDateAttend>dateTime</LastDateAttend>
            <LetterGrade>string</LetterGrade>
            <License>string</License>
            <MakeupDays>int</MakeupDays>
            <MakeupTimeMin>int</MakeupTimeMin>
            <NumberGrade>decimal</NumberGrade>
            <PossibleDays>int</PossibleDays>
            <PossibleTimeMin>int</PossibleTimeMin>
            <PresentDays>int</PresentDays>
            <PresentTimeMin>int</PresentTimeMin>
            <RegDate>dateTime</RegDate>
            <ClsStuStatusID>int</ClsStuStatusID>
            <TardyDays>int</TardyDays>
            <TardyTimeMin>int</TardyTimeMin>
            <TransferSchool>string</TransferSchool>
            <ClsStuTypeListID>int</ClsStuTypeListID>
            <UserData>string</UserData>
            <GradeLevelListID>int</GradeLevelListID>
            <StudentID>int</StudentID>
            <ClassEventID>int</ClassEventID>
            <Note>string</Note>
            <ClassGroupID>int</ClassGroupID>
            <ClsStuOSHrTypeListID>int</ClsStuOSHrTypeListID>
            <AbsentPolicyCnt>int</AbsentPolicyCnt>
            <TardyPolicyCnt>int</TardyPolicyCnt>
          </ClassStudent>
          <ClassStudent>
            <Class xsi:nil="true" />
            <ClassBalance>string</ClassBalance>
            <PathTitle>string</PathTitle>
            <ScheduleTitle>string</ScheduleTitle>
            <ClassGrades xsi:nil="true" />
            <StatusTitle>string</StatusTitle>
            <StatusDate>dateTime</StatusDate>
            <Student xsi:nil="true" />
            <StudentCode>string</StudentCode>
            <StudentName>string</StudentName>
            <StudentType>int</StudentType>
            <UICommands>string</UICommands>
            <OsHrTypeCode>string</OsHrTypeCode>
            <OsHrTypeTitle>string</OsHrTypeTitle>
            <AssociationID>int</AssociationID>
            <AttUpdate>dateTime</AttUpdate>
            <ClassID>int</ClassID>
            <ClassStudentID>int</ClassStudentID>
            <AbsentDays>int</AbsentDays>
            <AbsentTimeMin>int</AbsentTimeMin>
            <AutoLDA>boolean</AutoLDA>
            <Credits>decimal</Credits>
            <Dismissed>boolean</Dismissed>
            <EntryDate>dateTime</EntryDate>
            <ExcusedDays>int</ExcusedDays>
            <ExcusedTimeMin>int</ExcusedTimeMin>
            <ExitDate>dateTime</ExitDate>
            <ClsStuExitListID>int</ClsStuExitListID>
            <FinalizeDate>dateTime</FinalizeDate>
            <FirstEnroll>boolean</FirstEnroll>
            <Hours>decimal</Hours>
            <NoPathID>int</NoPathID>
            <NoTrans>boolean</NoTrans>
            <OnWaitList>boolean</OnWaitList>
            <OSHours>decimal</OSHours>
            <OSHourType>string</OSHourType>
            <PathStudentID>int</PathStudentID>
            <WaitDate>dateTime</WaitDate>
            <Weeks>int</Weeks>
            <ImportKey>int</ImportKey>
            <LastDateAttend>dateTime</LastDateAttend>
            <LetterGrade>string</LetterGrade>
            <License>string</License>
            <MakeupDays>int</MakeupDays>
            <MakeupTimeMin>int</MakeupTimeMin>
            <NumberGrade>decimal</NumberGrade>
            <PossibleDays>int</PossibleDays>
            <PossibleTimeMin>int</PossibleTimeMin>
            <PresentDays>int</PresentDays>
            <PresentTimeMin>int</PresentTimeMin>
            <RegDate>dateTime</RegDate>
            <ClsStuStatusID>int</ClsStuStatusID>
            <TardyDays>int</TardyDays>
            <TardyTimeMin>int</TardyTimeMin>
            <TransferSchool>string</TransferSchool>
            <ClsStuTypeListID>int</ClsStuTypeListID>
            <UserData>string</UserData>
            <GradeLevelListID>int</GradeLevelListID>
            <StudentID>int</StudentID>
            <ClassEventID>int</ClassEventID>
            <Note>string</Note>
            <ClassGroupID>int</ClassGroupID>
            <ClsStuOSHrTypeListID>int</ClsStuOSHrTypeListID>
            <AbsentPolicyCnt>int</AbsentPolicyCnt>
            <TardyPolicyCnt>int</TardyPolicyCnt>
          </ClassStudent>
        </ActiveEnrolledStudents>
        <ClassGradeActivities>
          <ClassActivity>
            <Activity xsi:nil="true" />
            <GroupActivities xsi:nil="true" />
            <ClassActivityID>int</ClassActivityID>
            <ClassID>int</ClassID>
            <GradeActivityID>int</GradeActivityID>
            <ImportKey>int</ImportKey>
          </ClassActivity>
          <ClassActivity>
            <Activity xsi:nil="true" />
            <GroupActivities xsi:nil="true" />
            <ClassActivityID>int</ClassActivityID>
            <ClassID>int</ClassID>
            <GradeActivityID>int</GradeActivityID>
            <ImportKey>int</ImportKey>
          </ClassActivity>
        </ClassGradeActivities>
        <ClassGroups>
          <ClassGroup>
            <GroupActivities xsi:nil="true" />
            <GroupGradeScale xsi:nil="true" />
            <ClassGroupID>int</ClassGroupID>
            <ClassID>int</ClassID>
            <Code>string</Code>
            <GradeScaleID>int</GradeScaleID>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </ClassGroup>
          <ClassGroup>
            <GroupActivities xsi:nil="true" />
            <GroupGradeScale xsi:nil="true" />
            <ClassGroupID>int</ClassGroupID>
            <ClassID>int</ClassID>
            <Code>string</Code>
            <GradeScaleID>int</GradeScaleID>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </ClassGroup>
        </ClassGroups>
        <ClassID>int</ClassID>
      </GetClassGradebookDataResult>
    </GetClassGradebookDataResponse>
  </soap12:Body>
</soap12:Envelope>