AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

GetProgramAuto

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

<?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>
    <GetProgramAuto xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </GetProgramAuto>
  </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>
    <GetProgramAutoResponse xmlns="http://www.Achademix.com/">
      <GetProgramAutoResult>
        <Program>
          <Summary>
            <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
            <CurrentActiveCount>int</CurrentActiveCount>
            <CurrentCompletedCount>int</CurrentCompletedCount>
            <CurrentDroppedCount>int</CurrentDroppedCount>
            <CurrentPendingCount>int</CurrentPendingCount>
            <CurrentWaitingCount>int</CurrentWaitingCount>
            <PrimaryTeacher>int</PrimaryTeacher>
            <ScheduleCount>int</ScheduleCount>
            <ScheduleExceptions>int</ScheduleExceptions>
            <ScheduleStartDate>dateTime</ScheduleStartDate>
            <ScheduleStopDate>dateTime</ScheduleStopDate>
            <TotalScheduledDays>int</TotalScheduledDays>
            <TotalScheduledMinutes>int</TotalScheduledMinutes>
            <TypicalBreakMinutes>int</TypicalBreakMinutes>
            <AllText>string</AllText>
          </Summary>
          <ClusterListID>int</ClusterListID>
          <DivisionListID>int</DivisionListID>
          <Code>string</Code>
          <Description>string</Description>
          <ImportKey>int</ImportKey>
          <Master>boolean</Master>
          <MaxSeats>int</MaxSeats>
          <Name>string</Name>
          <Status>string</Status>
          <UserData>string</UserData>
          <ProgramID>int</ProgramID>
          <SchoolID>int</SchoolID>
        </Program>
        <Program>
          <Summary>
            <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
            <CurrentActiveCount>int</CurrentActiveCount>
            <CurrentCompletedCount>int</CurrentCompletedCount>
            <CurrentDroppedCount>int</CurrentDroppedCount>
            <CurrentPendingCount>int</CurrentPendingCount>
            <CurrentWaitingCount>int</CurrentWaitingCount>
            <PrimaryTeacher>int</PrimaryTeacher>
            <ScheduleCount>int</ScheduleCount>
            <ScheduleExceptions>int</ScheduleExceptions>
            <ScheduleStartDate>dateTime</ScheduleStartDate>
            <ScheduleStopDate>dateTime</ScheduleStopDate>
            <TotalScheduledDays>int</TotalScheduledDays>
            <TotalScheduledMinutes>int</TotalScheduledMinutes>
            <TypicalBreakMinutes>int</TypicalBreakMinutes>
            <AllText>string</AllText>
          </Summary>
          <ClusterListID>int</ClusterListID>
          <DivisionListID>int</DivisionListID>
          <Code>string</Code>
          <Description>string</Description>
          <ImportKey>int</ImportKey>
          <Master>boolean</Master>
          <MaxSeats>int</MaxSeats>
          <Name>string</Name>
          <Status>string</Status>
          <UserData>string</UserData>
          <ProgramID>int</ProgramID>
          <SchoolID>int</SchoolID>
        </Program>
      </GetProgramAutoResult>
    </GetProgramAutoResponse>
  </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>
    <GetProgramAuto xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </GetProgramAuto>
  </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>
    <GetProgramAutoResponse xmlns="http://www.Achademix.com/">
      <GetProgramAutoResult>
        <Program>
          <Summary>
            <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
            <CurrentActiveCount>int</CurrentActiveCount>
            <CurrentCompletedCount>int</CurrentCompletedCount>
            <CurrentDroppedCount>int</CurrentDroppedCount>
            <CurrentPendingCount>int</CurrentPendingCount>
            <CurrentWaitingCount>int</CurrentWaitingCount>
            <PrimaryTeacher>int</PrimaryTeacher>
            <ScheduleCount>int</ScheduleCount>
            <ScheduleExceptions>int</ScheduleExceptions>
            <ScheduleStartDate>dateTime</ScheduleStartDate>
            <ScheduleStopDate>dateTime</ScheduleStopDate>
            <TotalScheduledDays>int</TotalScheduledDays>
            <TotalScheduledMinutes>int</TotalScheduledMinutes>
            <TypicalBreakMinutes>int</TypicalBreakMinutes>
            <AllText>string</AllText>
          </Summary>
          <ClusterListID>int</ClusterListID>
          <DivisionListID>int</DivisionListID>
          <Code>string</Code>
          <Description>string</Description>
          <ImportKey>int</ImportKey>
          <Master>boolean</Master>
          <MaxSeats>int</MaxSeats>
          <Name>string</Name>
          <Status>string</Status>
          <UserData>string</UserData>
          <ProgramID>int</ProgramID>
          <SchoolID>int</SchoolID>
        </Program>
        <Program>
          <Summary>
            <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
            <CurrentActiveCount>int</CurrentActiveCount>
            <CurrentCompletedCount>int</CurrentCompletedCount>
            <CurrentDroppedCount>int</CurrentDroppedCount>
            <CurrentPendingCount>int</CurrentPendingCount>
            <CurrentWaitingCount>int</CurrentWaitingCount>
            <PrimaryTeacher>int</PrimaryTeacher>
            <ScheduleCount>int</ScheduleCount>
            <ScheduleExceptions>int</ScheduleExceptions>
            <ScheduleStartDate>dateTime</ScheduleStartDate>
            <ScheduleStopDate>dateTime</ScheduleStopDate>
            <TotalScheduledDays>int</TotalScheduledDays>
            <TotalScheduledMinutes>int</TotalScheduledMinutes>
            <TypicalBreakMinutes>int</TypicalBreakMinutes>
            <AllText>string</AllText>
          </Summary>
          <ClusterListID>int</ClusterListID>
          <DivisionListID>int</DivisionListID>
          <Code>string</Code>
          <Description>string</Description>
          <ImportKey>int</ImportKey>
          <Master>boolean</Master>
          <MaxSeats>int</MaxSeats>
          <Name>string</Name>
          <Status>string</Status>
          <UserData>string</UserData>
          <ProgramID>int</ProgramID>
          <SchoolID>int</SchoolID>
        </Program>
      </GetProgramAutoResult>
    </GetProgramAutoResponse>
  </soap12:Body>
</soap12:Envelope>