AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SaveGradeCard

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/SaveGradeCard"

<?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>
    <SaveGradeCard xmlns="http://www.Achademix.com/">
      <TheCard>
        <FeedAddress>string</FeedAddress>
        <FeedCity>string</FeedCity>
        <FeedContactName>string</FeedContactName>
        <FeedFax>string</FeedFax>
        <FeedPhone>string</FeedPhone>
        <FeedSchoolID>int</FeedSchoolID>
        <FeedSchoolName>string</FeedSchoolName>
        <FeedState>string</FeedState>
        <Feedzip>string</Feedzip>
        <GradePeriod>
          <PostedDate>dateTime</PostedDate>
          <Posting>
            <GradePeriod xsi:nil="true" />
            <GradeCardPostingID>int</GradeCardPostingID>
            <ClassID>int</ClassID>
            <PathID>int</PathID>
            <SegmentGrade>boolean</SegmentGrade>
            <SegmentStart>dateTime</SegmentStart>
            <GradePeriodListID>int</GradePeriodListID>
            <SegmentEnd>dateTime</SegmentEnd>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </Posting>
          <GradePeriodListID>int</GradePeriodListID>
          <Code>string</Code>
          <Federal>string</Federal>
          <SIF>string</SIF>
          <State>string</State>
          <Title>string</Title>
          <IsActive>boolean</IsActive>
          <IsSystem>boolean</IsSystem>
          <ListOrder>string</ListOrder>
        </GradePeriod>
        <ClassOrPathTitle>string</ClassOrPathTitle>
        <Student>
          <Associations>string</Associations>
          <Attendance>
            <Attendance xsi:nil="true" />
            <Attendance xsi:nil="true" />
          </Attendance>
          <ClsDocuments>
            <ClassStuNote xsi:nil="true" />
            <ClassStuNote xsi:nil="true" />
          </ClsDocuments>
          <Documents>
            <StudentNote xsi:nil="true" />
            <StudentNote xsi:nil="true" />
          </Documents>
          <FlagImage>base64Binary</FlagImage>
          <GradeLevel>string</GradeLevel>
          <LeadInfo>
            <Activity xsi:nil="true" />
            <LeadPath xsi:nil="true" />
            <SummaryLead xsi:nil="true" />
            <AlertLevel>int</AlertLevel>
            <LeadID>int</LeadID>
            <LeadSourceID>int</LeadSourceID>
            <ImportKey>int</ImportKey>
            <LeaIntrestListID>int</LeaIntrestListID>
            <Note>string</Note>
            <ProposedStartDate>dateTime</ProposedStartDate>
            <LeaStatusListID>int</LeaStatusListID>
            <Rank>int</Rank>
            <UserData>string</UserData>
            <StaffID>int</StaffID>
            <StudentID>int</StudentID>
            <LeaSessionListID>int</LeaSessionListID>
            <ApplicationDate>dateTime</ApplicationDate>
            <InitalContactDate>dateTime</InitalContactDate>
          </LeadInfo>
          <PathEnrollments>
            <PathStudent xsi:nil="true" />
            <PathStudent xsi:nil="true" />
          </PathEnrollments>
          <ClassEnrollments>
            <ClassStudent xsi:nil="true" />
            <ClassStudent xsi:nil="true" />
          </ClassEnrollments>
          <FeedEnrollments>
            <FeedStudent xsi:nil="true" />
            <FeedStudent xsi:nil="true" />
          </FeedEnrollments>
          <PthDocuments>
            <PathStuNote xsi:nil="true" />
            <PathStuNote xsi:nil="true" />
          </PthDocuments>
          <FunDocuments>
            <FundStuNote xsi:nil="true" />
            <FundStuNote xsi:nil="true" />
          </FunDocuments>
          <T4Packages>
            <StuT4Package xsi:nil="true" />
            <StuT4Package xsi:nil="true" />
          </T4Packages>
          <WrkDocuments>
            <WorkStuNote xsi:nil="true" />
            <WorkStuNote xsi:nil="true" />
          </WrkDocuments>
          <SkillEnrollments>
            <SkillStudent xsi:nil="true" />
            <SkillStudent xsi:nil="true" />
          </SkillEnrollments>
          <WorkEnrollments>
            <WorkStudent xsi:nil="true" />
            <WorkStudent xsi:nil="true" />
          </WorkEnrollments>
          <StatusTitle>string</StatusTitle>
          <Summary>
            <AccountBalance>string</AccountBalance>
            <Attendance>string</Attendance>
            <CurrentLocation>string</CurrentLocation>
            <EmergencyContact>string</EmergencyContact>
            <LastPortalAccess>string</LastPortalAccess>
            <LatestFeed>string</LatestFeed>
            <LatestPath>string</LatestPath>
            <LatestWork>string</LatestWork>
            <PathCurrentGrade>string</PathCurrentGrade>
            <PathSchedule>string</PathSchedule>
            <PathWeeksAttend>string</PathWeeksAttend>
            <PrimaryAddress>string</PrimaryAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <Email>string</Email>
            <Alerts xsi:nil="true" />
            <AttPolicyCount>string</AttPolicyCount>
          </Summary>
          <TypeTitle>string</TypeTitle>
          <DistrictTitle>string</DistrictTitle>
          <ResidencyTitle>string</ResidencyTitle>
          <AdvisorID>int</AdvisorID>
          <HSACTCode>string</HSACTCode>
          <HSInfo>string</HSInfo>
          <HSOutofState>boolean</HSOutofState>
          <NoMarket>boolean</NoMarket>
          <StudentID>int</StudentID>
          <Disadvantaged>int</Disadvantaged>
          <StuDistrictID>int</StuDistrictID>
          <StuEnglishAbilityListID>int</StuEnglishAbilityListID>
          <HSGradDate>string</HSGradDate>
          <StuFlagListID>int</StuFlagListID>
          <StuImportKey>int</StuImportKey>
          <IsFirstTime>boolean</IsFirstTime>
          <IsResident>boolean</IsResident>
          <StuResidencyListID>int</StuResidencyListID>
          <StuResVerifyListID>int</StuResVerifyListID>
          <StaffSetPic>boolean</StaffSetPic>
          <StuStatusID>int</StuStatusID>
          <StuTypeListID>int</StuTypeListID>
          <LMSData>string</LMSData>
        </Student>
        <GradeCardMetrics>
          <GradeCardMetric>
            <Metric xsi:nil="true" />
            <Response xsi:nil="true" />
            <Note>string</Note>
            <GradeCardID>int</GradeCardID>
            <GradeCardMetricID>int</GradeCardMetricID>
            <MetricListID>int</MetricListID>
            <MetricResponseListID>int</MetricResponseListID>
          </GradeCardMetric>
          <GradeCardMetric>
            <Metric xsi:nil="true" />
            <Response xsi:nil="true" />
            <Note>string</Note>
            <GradeCardID>int</GradeCardID>
            <GradeCardMetricID>int</GradeCardMetricID>
            <MetricListID>int</MetricListID>
            <MetricResponseListID>int</MetricResponseListID>
          </GradeCardMetric>
        </GradeCardMetrics>
        <ClassStudentID>int</ClassStudentID>
        <GradeCardID>int</GradeCardID>
        <GradePeriodListID>int</GradePeriodListID>
        <Credits>decimal</Credits>
        <Hours>decimal</Hours>
        <ImportKey>int</ImportKey>
        <LetterGrade>string</LetterGrade>
        <GrdNote>string</GrdNote>
        <PercenGrade>decimal</PercenGrade>
        <PointGrade>int</PointGrade>
        <PostDate>dateTime</PostDate>
        <PathStudentID>int</PathStudentID>
        <WorkStudentID>int</WorkStudentID>
        <Audit>string</Audit>
        <GradeCardPostingID>int</GradeCardPostingID>
      </TheCard>
    </SaveGradeCard>
  </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>
    <SaveGradeCardResponse xmlns="http://www.Achademix.com/">
      <SaveGradeCardResult>int</SaveGradeCardResult>
    </SaveGradeCardResponse>
  </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>
    <SaveGradeCard xmlns="http://www.Achademix.com/">
      <TheCard>
        <FeedAddress>string</FeedAddress>
        <FeedCity>string</FeedCity>
        <FeedContactName>string</FeedContactName>
        <FeedFax>string</FeedFax>
        <FeedPhone>string</FeedPhone>
        <FeedSchoolID>int</FeedSchoolID>
        <FeedSchoolName>string</FeedSchoolName>
        <FeedState>string</FeedState>
        <Feedzip>string</Feedzip>
        <GradePeriod>
          <PostedDate>dateTime</PostedDate>
          <Posting>
            <GradePeriod xsi:nil="true" />
            <GradeCardPostingID>int</GradeCardPostingID>
            <ClassID>int</ClassID>
            <PathID>int</PathID>
            <SegmentGrade>boolean</SegmentGrade>
            <SegmentStart>dateTime</SegmentStart>
            <GradePeriodListID>int</GradePeriodListID>
            <SegmentEnd>dateTime</SegmentEnd>
            <ImportKey>int</ImportKey>
            <Title>string</Title>
          </Posting>
          <GradePeriodListID>int</GradePeriodListID>
          <Code>string</Code>
          <Federal>string</Federal>
          <SIF>string</SIF>
          <State>string</State>
          <Title>string</Title>
          <IsActive>boolean</IsActive>
          <IsSystem>boolean</IsSystem>
          <ListOrder>string</ListOrder>
        </GradePeriod>
        <ClassOrPathTitle>string</ClassOrPathTitle>
        <Student>
          <Associations>string</Associations>
          <Attendance>
            <Attendance xsi:nil="true" />
            <Attendance xsi:nil="true" />
          </Attendance>
          <ClsDocuments>
            <ClassStuNote xsi:nil="true" />
            <ClassStuNote xsi:nil="true" />
          </ClsDocuments>
          <Documents>
            <StudentNote xsi:nil="true" />
            <StudentNote xsi:nil="true" />
          </Documents>
          <FlagImage>base64Binary</FlagImage>
          <GradeLevel>string</GradeLevel>
          <LeadInfo>
            <Activity xsi:nil="true" />
            <LeadPath xsi:nil="true" />
            <SummaryLead xsi:nil="true" />
            <AlertLevel>int</AlertLevel>
            <LeadID>int</LeadID>
            <LeadSourceID>int</LeadSourceID>
            <ImportKey>int</ImportKey>
            <LeaIntrestListID>int</LeaIntrestListID>
            <Note>string</Note>
            <ProposedStartDate>dateTime</ProposedStartDate>
            <LeaStatusListID>int</LeaStatusListID>
            <Rank>int</Rank>
            <UserData>string</UserData>
            <StaffID>int</StaffID>
            <StudentID>int</StudentID>
            <LeaSessionListID>int</LeaSessionListID>
            <ApplicationDate>dateTime</ApplicationDate>
            <InitalContactDate>dateTime</InitalContactDate>
          </LeadInfo>
          <PathEnrollments>
            <PathStudent xsi:nil="true" />
            <PathStudent xsi:nil="true" />
          </PathEnrollments>
          <ClassEnrollments>
            <ClassStudent xsi:nil="true" />
            <ClassStudent xsi:nil="true" />
          </ClassEnrollments>
          <FeedEnrollments>
            <FeedStudent xsi:nil="true" />
            <FeedStudent xsi:nil="true" />
          </FeedEnrollments>
          <PthDocuments>
            <PathStuNote xsi:nil="true" />
            <PathStuNote xsi:nil="true" />
          </PthDocuments>
          <FunDocuments>
            <FundStuNote xsi:nil="true" />
            <FundStuNote xsi:nil="true" />
          </FunDocuments>
          <T4Packages>
            <StuT4Package xsi:nil="true" />
            <StuT4Package xsi:nil="true" />
          </T4Packages>
          <WrkDocuments>
            <WorkStuNote xsi:nil="true" />
            <WorkStuNote xsi:nil="true" />
          </WrkDocuments>
          <SkillEnrollments>
            <SkillStudent xsi:nil="true" />
            <SkillStudent xsi:nil="true" />
          </SkillEnrollments>
          <WorkEnrollments>
            <WorkStudent xsi:nil="true" />
            <WorkStudent xsi:nil="true" />
          </WorkEnrollments>
          <StatusTitle>string</StatusTitle>
          <Summary>
            <AccountBalance>string</AccountBalance>
            <Attendance>string</Attendance>
            <CurrentLocation>string</CurrentLocation>
            <EmergencyContact>string</EmergencyContact>
            <LastPortalAccess>string</LastPortalAccess>
            <LatestFeed>string</LatestFeed>
            <LatestPath>string</LatestPath>
            <LatestWork>string</LatestWork>
            <PathCurrentGrade>string</PathCurrentGrade>
            <PathSchedule>string</PathSchedule>
            <PathWeeksAttend>string</PathWeeksAttend>
            <PrimaryAddress>string</PrimaryAddress>
            <PrimaryPhone>string</PrimaryPhone>
            <Email>string</Email>
            <Alerts xsi:nil="true" />
            <AttPolicyCount>string</AttPolicyCount>
          </Summary>
          <TypeTitle>string</TypeTitle>
          <DistrictTitle>string</DistrictTitle>
          <ResidencyTitle>string</ResidencyTitle>
          <AdvisorID>int</AdvisorID>
          <HSACTCode>string</HSACTCode>
          <HSInfo>string</HSInfo>
          <HSOutofState>boolean</HSOutofState>
          <NoMarket>boolean</NoMarket>
          <StudentID>int</StudentID>
          <Disadvantaged>int</Disadvantaged>
          <StuDistrictID>int</StuDistrictID>
          <StuEnglishAbilityListID>int</StuEnglishAbilityListID>
          <HSGradDate>string</HSGradDate>
          <StuFlagListID>int</StuFlagListID>
          <StuImportKey>int</StuImportKey>
          <IsFirstTime>boolean</IsFirstTime>
          <IsResident>boolean</IsResident>
          <StuResidencyListID>int</StuResidencyListID>
          <StuResVerifyListID>int</StuResVerifyListID>
          <StaffSetPic>boolean</StaffSetPic>
          <StuStatusID>int</StuStatusID>
          <StuTypeListID>int</StuTypeListID>
          <LMSData>string</LMSData>
        </Student>
        <GradeCardMetrics>
          <GradeCardMetric>
            <Metric xsi:nil="true" />
            <Response xsi:nil="true" />
            <Note>string</Note>
            <GradeCardID>int</GradeCardID>
            <GradeCardMetricID>int</GradeCardMetricID>
            <MetricListID>int</MetricListID>
            <MetricResponseListID>int</MetricResponseListID>
          </GradeCardMetric>
          <GradeCardMetric>
            <Metric xsi:nil="true" />
            <Response xsi:nil="true" />
            <Note>string</Note>
            <GradeCardID>int</GradeCardID>
            <GradeCardMetricID>int</GradeCardMetricID>
            <MetricListID>int</MetricListID>
            <MetricResponseListID>int</MetricResponseListID>
          </GradeCardMetric>
        </GradeCardMetrics>
        <ClassStudentID>int</ClassStudentID>
        <GradeCardID>int</GradeCardID>
        <GradePeriodListID>int</GradePeriodListID>
        <Credits>decimal</Credits>
        <Hours>decimal</Hours>
        <ImportKey>int</ImportKey>
        <LetterGrade>string</LetterGrade>
        <GrdNote>string</GrdNote>
        <PercenGrade>decimal</PercenGrade>
        <PointGrade>int</PointGrade>
        <PostDate>dateTime</PostDate>
        <PathStudentID>int</PathStudentID>
        <WorkStudentID>int</WorkStudentID>
        <Audit>string</Audit>
        <GradeCardPostingID>int</GradeCardPostingID>
      </TheCard>
    </SaveGradeCard>
  </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>
    <SaveGradeCardResponse xmlns="http://www.Achademix.com/">
      <SaveGradeCardResult>int</SaveGradeCardResult>
    </SaveGradeCardResponse>
  </soap12:Body>
</soap12:Envelope>