AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SelectSchoolByUserId

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

<?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>
    <SelectSchoolByUserId xmlns="http://www.Achademix.com/">
      <UserId>int</UserId>
    </SelectSchoolByUserId>
  </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>
    <SelectSchoolByUserIdResponse xmlns="http://www.Achademix.com/">
      <SelectSchoolByUserIdResult>
        <Campus>
          <Campus>
            <AddressList xsi:nil="true" />
            <Primary>int</Primary>
            <CalendarID>int</CalendarID>
            <CamEmail>string</CamEmail>
            <CamFax>string</CamFax>
            <CamFederalCode>string</CamFederalCode>
            <CamPhone>string</CamPhone>
            <CamStateCode>string</CamStateCode>
            <CamURL>string</CamURL>
            <CCAPILogin>string</CCAPILogin>
            <CCTransKey>string</CCTransKey>
            <CCURL>string</CCURL>
            <Code>string</Code>
            <Descript>string</Descript>
            <Note>string</Note>
            <ImportKey>int</ImportKey>
            <Main>boolean</Main>
            <Name>string</Name>
            <CampusID>int</CampusID>
            <UserData>string</UserData>
            <SchoolID>int</SchoolID>
          </Campus>
          <Campus>
            <AddressList xsi:nil="true" />
            <Primary>int</Primary>
            <CalendarID>int</CalendarID>
            <CamEmail>string</CamEmail>
            <CamFax>string</CamFax>
            <CamFederalCode>string</CamFederalCode>
            <CamPhone>string</CamPhone>
            <CamStateCode>string</CamStateCode>
            <CamURL>string</CamURL>
            <CCAPILogin>string</CCAPILogin>
            <CCTransKey>string</CCTransKey>
            <CCURL>string</CCURL>
            <Code>string</Code>
            <Descript>string</Descript>
            <Note>string</Note>
            <ImportKey>int</ImportKey>
            <Main>boolean</Main>
            <Name>string</Name>
            <CampusID>int</CampusID>
            <UserData>string</UserData>
            <SchoolID>int</SchoolID>
          </Campus>
        </Campus>
        <Documents>
          <SchoolNote>
            <Note xsi:nil="true" />
            <NoteType xsi:nil="true" />
            <NoteID>int</NoteID>
            <SchNotTypeListID>int</SchNotTypeListID>
            <SchoolID>int</SchoolID>
            <SchoolNoteID>int</SchoolNoteID>
          </SchoolNote>
          <SchoolNote>
            <Note xsi:nil="true" />
            <NoteType xsi:nil="true" />
            <NoteID>int</NoteID>
            <SchNotTypeListID>int</SchNotTypeListID>
            <SchoolID>int</SchoolID>
            <SchoolNoteID>int</SchoolNoteID>
          </SchoolNote>
        </Documents>
        <MasterCalendar>
          <CalendarID>int</CalendarID>
          <Title>string</Title>
          <Type>int</Type>
          <SchoolID>int</SchoolID>
        </MasterCalendar>
        <Summary>
          <AllText>string</AllText>
          <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
        </Summary>
        <Address>string</Address>
        <City>string</City>
        <DistrictID>int</DistrictID>
        <Code>string</Code>
        <FederalCode>string</FederalCode>
        <ReportURL>string</ReportURL>
        <Sch1098TCC>string</Sch1098TCC>
        <SchEIN>string</SchEIN>
        <ImportKey>int</ImportKey>
        <Name>string</Name>
        <SchoolID>int</SchoolID>
        <OPEID>string</OPEID>
        <State>string</State>
        <StateCode>string</StateCode>
        <URL>string</URL>
        <UserData>string</UserData>
        <WeeklyHoursID>int</WeeklyHoursID>
        <Fax>string</Fax>
        <Email>string</Email>
        <FiscalYearStart>int</FiscalYearStart>
        <Phone>string</Phone>
        <Zip>string</Zip>
      </SelectSchoolByUserIdResult>
    </SelectSchoolByUserIdResponse>
  </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>
    <SelectSchoolByUserId xmlns="http://www.Achademix.com/">
      <UserId>int</UserId>
    </SelectSchoolByUserId>
  </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>
    <SelectSchoolByUserIdResponse xmlns="http://www.Achademix.com/">
      <SelectSchoolByUserIdResult>
        <Campus>
          <Campus>
            <AddressList xsi:nil="true" />
            <Primary>int</Primary>
            <CalendarID>int</CalendarID>
            <CamEmail>string</CamEmail>
            <CamFax>string</CamFax>
            <CamFederalCode>string</CamFederalCode>
            <CamPhone>string</CamPhone>
            <CamStateCode>string</CamStateCode>
            <CamURL>string</CamURL>
            <CCAPILogin>string</CCAPILogin>
            <CCTransKey>string</CCTransKey>
            <CCURL>string</CCURL>
            <Code>string</Code>
            <Descript>string</Descript>
            <Note>string</Note>
            <ImportKey>int</ImportKey>
            <Main>boolean</Main>
            <Name>string</Name>
            <CampusID>int</CampusID>
            <UserData>string</UserData>
            <SchoolID>int</SchoolID>
          </Campus>
          <Campus>
            <AddressList xsi:nil="true" />
            <Primary>int</Primary>
            <CalendarID>int</CalendarID>
            <CamEmail>string</CamEmail>
            <CamFax>string</CamFax>
            <CamFederalCode>string</CamFederalCode>
            <CamPhone>string</CamPhone>
            <CamStateCode>string</CamStateCode>
            <CamURL>string</CamURL>
            <CCAPILogin>string</CCAPILogin>
            <CCTransKey>string</CCTransKey>
            <CCURL>string</CCURL>
            <Code>string</Code>
            <Descript>string</Descript>
            <Note>string</Note>
            <ImportKey>int</ImportKey>
            <Main>boolean</Main>
            <Name>string</Name>
            <CampusID>int</CampusID>
            <UserData>string</UserData>
            <SchoolID>int</SchoolID>
          </Campus>
        </Campus>
        <Documents>
          <SchoolNote>
            <Note xsi:nil="true" />
            <NoteType xsi:nil="true" />
            <NoteID>int</NoteID>
            <SchNotTypeListID>int</SchNotTypeListID>
            <SchoolID>int</SchoolID>
            <SchoolNoteID>int</SchoolNoteID>
          </SchoolNote>
          <SchoolNote>
            <Note xsi:nil="true" />
            <NoteType xsi:nil="true" />
            <NoteID>int</NoteID>
            <SchNotTypeListID>int</SchNotTypeListID>
            <SchoolID>int</SchoolID>
            <SchoolNoteID>int</SchoolNoteID>
          </SchoolNote>
        </Documents>
        <MasterCalendar>
          <CalendarID>int</CalendarID>
          <Title>string</Title>
          <Type>int</Type>
          <SchoolID>int</SchoolID>
        </MasterCalendar>
        <Summary>
          <AllText>string</AllText>
          <CurrentEnrollmentCount>int</CurrentEnrollmentCount>
        </Summary>
        <Address>string</Address>
        <City>string</City>
        <DistrictID>int</DistrictID>
        <Code>string</Code>
        <FederalCode>string</FederalCode>
        <ReportURL>string</ReportURL>
        <Sch1098TCC>string</Sch1098TCC>
        <SchEIN>string</SchEIN>
        <ImportKey>int</ImportKey>
        <Name>string</Name>
        <SchoolID>int</SchoolID>
        <OPEID>string</OPEID>
        <State>string</State>
        <StateCode>string</StateCode>
        <URL>string</URL>
        <UserData>string</UserData>
        <WeeklyHoursID>int</WeeklyHoursID>
        <Fax>string</Fax>
        <Email>string</Email>
        <FiscalYearStart>int</FiscalYearStart>
        <Phone>string</Phone>
        <Zip>string</Zip>
      </SelectSchoolByUserIdResult>
    </SelectSchoolByUserIdResponse>
  </soap12:Body>
</soap12:Envelope>