AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

CollectStudentReqDoc

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

<?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>
    <CollectStudentReqDoc xmlns="http://www.Achademix.com/">
      <StudentID>int</StudentID>
    </CollectStudentReqDoc>
  </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>
    <CollectStudentReqDocResponse xmlns="http://www.Achademix.com/">
      <CollectStudentReqDocResult>
        <StudentReqDoc>
          <Accepted>boolean</Accepted>
          <AttachReq>boolean</AttachReq>
          <DefaultExpDays>int</DefaultExpDays>
          <DeficientDate>dateTime</DeficientDate>
          <DocTypeListID>int</DocTypeListID>
          <DocumentStatus>string</DocumentStatus>
          <DocumentTitle>string</DocumentTitle>
          <ExpireDate>dateTime</ExpireDate>
          <Expires>boolean</Expires>
          <GroupOrder>string</GroupOrder>
          <HasAttachement>boolean</HasAttachement>
          <IsDeleted>boolean</IsDeleted>
          <KillIfDone>boolean</KillIfDone>
          <Level>int</Level>
          <Lifespan>int</Lifespan>
          <NoteAddDate>dateTime</NoteAddDate>
          <NoteAddUser>int</NoteAddUser>
          <NoteReqOption>
            <ExperationDate>dateTime</ExperationDate>
            <DayOffType>int</DayOffType>
            <DefaultExpDays>int</DefaultExpDays>
            <DocTypeListID>int</DocTypeListID>
            <KillIfDone>boolean</KillIfDone>
            <Lifespan>int</Lifespan>
            <NoteReqOptionID>int</NoteReqOptionID>
            <DailyOffset>int</DailyOffset>
            <Escalate>boolean</Escalate>
            <Expires>boolean</Expires>
            <IsPublished>boolean</IsPublished>
            <Level>int</Level>
            <NoNotify>boolean</NoNotify>
            <NoTrack>boolean</NoTrack>
            <OdrContent>string</OdrContent>
            <OdrInstruction>string</OdrInstruction>
            <OdrType>int</OdrType>
            <Order>string</Order>
            <StatusBlock>int</StatusBlock>
            <StuTypeListID>int</StuTypeListID>
            <NotifyStudent>boolean</NotifyStudent>
          </NoteReqOption>
          <NoteStatusID>int</NoteStatusID>
          <NoteTypeID>int</NoteTypeID>
          <NoTrack>boolean</NoTrack>
          <OdrValidate>boolean</OdrValidate>
          <ServiceModule>string</ServiceModule>
          <SourceDoc>int</SourceDoc>
          <SourceID>int</SourceID>
          <StatusBlock>int</StatusBlock>
          <StatusTitle>string</StatusTitle>
          <StudentID>int</StudentID>
          <StudentResponse>boolean</StudentResponse>
          <VerifyDate>dateTime</VerifyDate>
          <VerifyStatus>short</VerifyStatus>
          <VerifyUser>int</VerifyUser>
        </StudentReqDoc>
        <StudentReqDoc>
          <Accepted>boolean</Accepted>
          <AttachReq>boolean</AttachReq>
          <DefaultExpDays>int</DefaultExpDays>
          <DeficientDate>dateTime</DeficientDate>
          <DocTypeListID>int</DocTypeListID>
          <DocumentStatus>string</DocumentStatus>
          <DocumentTitle>string</DocumentTitle>
          <ExpireDate>dateTime</ExpireDate>
          <Expires>boolean</Expires>
          <GroupOrder>string</GroupOrder>
          <HasAttachement>boolean</HasAttachement>
          <IsDeleted>boolean</IsDeleted>
          <KillIfDone>boolean</KillIfDone>
          <Level>int</Level>
          <Lifespan>int</Lifespan>
          <NoteAddDate>dateTime</NoteAddDate>
          <NoteAddUser>int</NoteAddUser>
          <NoteReqOption>
            <ExperationDate>dateTime</ExperationDate>
            <DayOffType>int</DayOffType>
            <DefaultExpDays>int</DefaultExpDays>
            <DocTypeListID>int</DocTypeListID>
            <KillIfDone>boolean</KillIfDone>
            <Lifespan>int</Lifespan>
            <NoteReqOptionID>int</NoteReqOptionID>
            <DailyOffset>int</DailyOffset>
            <Escalate>boolean</Escalate>
            <Expires>boolean</Expires>
            <IsPublished>boolean</IsPublished>
            <Level>int</Level>
            <NoNotify>boolean</NoNotify>
            <NoTrack>boolean</NoTrack>
            <OdrContent>string</OdrContent>
            <OdrInstruction>string</OdrInstruction>
            <OdrType>int</OdrType>
            <Order>string</Order>
            <StatusBlock>int</StatusBlock>
            <StuTypeListID>int</StuTypeListID>
            <NotifyStudent>boolean</NotifyStudent>
          </NoteReqOption>
          <NoteStatusID>int</NoteStatusID>
          <NoteTypeID>int</NoteTypeID>
          <NoTrack>boolean</NoTrack>
          <OdrValidate>boolean</OdrValidate>
          <ServiceModule>string</ServiceModule>
          <SourceDoc>int</SourceDoc>
          <SourceID>int</SourceID>
          <StatusBlock>int</StatusBlock>
          <StatusTitle>string</StatusTitle>
          <StudentID>int</StudentID>
          <StudentResponse>boolean</StudentResponse>
          <VerifyDate>dateTime</VerifyDate>
          <VerifyStatus>short</VerifyStatus>
          <VerifyUser>int</VerifyUser>
        </StudentReqDoc>
      </CollectStudentReqDocResult>
    </CollectStudentReqDocResponse>
  </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>
    <CollectStudentReqDoc xmlns="http://www.Achademix.com/">
      <StudentID>int</StudentID>
    </CollectStudentReqDoc>
  </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>
    <CollectStudentReqDocResponse xmlns="http://www.Achademix.com/">
      <CollectStudentReqDocResult>
        <StudentReqDoc>
          <Accepted>boolean</Accepted>
          <AttachReq>boolean</AttachReq>
          <DefaultExpDays>int</DefaultExpDays>
          <DeficientDate>dateTime</DeficientDate>
          <DocTypeListID>int</DocTypeListID>
          <DocumentStatus>string</DocumentStatus>
          <DocumentTitle>string</DocumentTitle>
          <ExpireDate>dateTime</ExpireDate>
          <Expires>boolean</Expires>
          <GroupOrder>string</GroupOrder>
          <HasAttachement>boolean</HasAttachement>
          <IsDeleted>boolean</IsDeleted>
          <KillIfDone>boolean</KillIfDone>
          <Level>int</Level>
          <Lifespan>int</Lifespan>
          <NoteAddDate>dateTime</NoteAddDate>
          <NoteAddUser>int</NoteAddUser>
          <NoteReqOption>
            <ExperationDate>dateTime</ExperationDate>
            <DayOffType>int</DayOffType>
            <DefaultExpDays>int</DefaultExpDays>
            <DocTypeListID>int</DocTypeListID>
            <KillIfDone>boolean</KillIfDone>
            <Lifespan>int</Lifespan>
            <NoteReqOptionID>int</NoteReqOptionID>
            <DailyOffset>int</DailyOffset>
            <Escalate>boolean</Escalate>
            <Expires>boolean</Expires>
            <IsPublished>boolean</IsPublished>
            <Level>int</Level>
            <NoNotify>boolean</NoNotify>
            <NoTrack>boolean</NoTrack>
            <OdrContent>string</OdrContent>
            <OdrInstruction>string</OdrInstruction>
            <OdrType>int</OdrType>
            <Order>string</Order>
            <StatusBlock>int</StatusBlock>
            <StuTypeListID>int</StuTypeListID>
            <NotifyStudent>boolean</NotifyStudent>
          </NoteReqOption>
          <NoteStatusID>int</NoteStatusID>
          <NoteTypeID>int</NoteTypeID>
          <NoTrack>boolean</NoTrack>
          <OdrValidate>boolean</OdrValidate>
          <ServiceModule>string</ServiceModule>
          <SourceDoc>int</SourceDoc>
          <SourceID>int</SourceID>
          <StatusBlock>int</StatusBlock>
          <StatusTitle>string</StatusTitle>
          <StudentID>int</StudentID>
          <StudentResponse>boolean</StudentResponse>
          <VerifyDate>dateTime</VerifyDate>
          <VerifyStatus>short</VerifyStatus>
          <VerifyUser>int</VerifyUser>
        </StudentReqDoc>
        <StudentReqDoc>
          <Accepted>boolean</Accepted>
          <AttachReq>boolean</AttachReq>
          <DefaultExpDays>int</DefaultExpDays>
          <DeficientDate>dateTime</DeficientDate>
          <DocTypeListID>int</DocTypeListID>
          <DocumentStatus>string</DocumentStatus>
          <DocumentTitle>string</DocumentTitle>
          <ExpireDate>dateTime</ExpireDate>
          <Expires>boolean</Expires>
          <GroupOrder>string</GroupOrder>
          <HasAttachement>boolean</HasAttachement>
          <IsDeleted>boolean</IsDeleted>
          <KillIfDone>boolean</KillIfDone>
          <Level>int</Level>
          <Lifespan>int</Lifespan>
          <NoteAddDate>dateTime</NoteAddDate>
          <NoteAddUser>int</NoteAddUser>
          <NoteReqOption>
            <ExperationDate>dateTime</ExperationDate>
            <DayOffType>int</DayOffType>
            <DefaultExpDays>int</DefaultExpDays>
            <DocTypeListID>int</DocTypeListID>
            <KillIfDone>boolean</KillIfDone>
            <Lifespan>int</Lifespan>
            <NoteReqOptionID>int</NoteReqOptionID>
            <DailyOffset>int</DailyOffset>
            <Escalate>boolean</Escalate>
            <Expires>boolean</Expires>
            <IsPublished>boolean</IsPublished>
            <Level>int</Level>
            <NoNotify>boolean</NoNotify>
            <NoTrack>boolean</NoTrack>
            <OdrContent>string</OdrContent>
            <OdrInstruction>string</OdrInstruction>
            <OdrType>int</OdrType>
            <Order>string</Order>
            <StatusBlock>int</StatusBlock>
            <StuTypeListID>int</StuTypeListID>
            <NotifyStudent>boolean</NotifyStudent>
          </NoteReqOption>
          <NoteStatusID>int</NoteStatusID>
          <NoteTypeID>int</NoteTypeID>
          <NoTrack>boolean</NoTrack>
          <OdrValidate>boolean</OdrValidate>
          <ServiceModule>string</ServiceModule>
          <SourceDoc>int</SourceDoc>
          <SourceID>int</SourceID>
          <StatusBlock>int</StatusBlock>
          <StatusTitle>string</StatusTitle>
          <StudentID>int</StudentID>
          <StudentResponse>boolean</StudentResponse>
          <VerifyDate>dateTime</VerifyDate>
          <VerifyStatus>short</VerifyStatus>
          <VerifyUser>int</VerifyUser>
        </StudentReqDoc>
      </CollectStudentReqDocResult>
    </CollectStudentReqDocResponse>
  </soap12:Body>
</soap12:Envelope>