AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SelectDistributionQuick

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

<?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>
    <SelectDistributionQuick xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </SelectDistributionQuick>
  </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>
    <SelectDistributionQuickResponse xmlns="http://www.Achademix.com/">
      <SelectDistributionQuickResult>
        <Distribution>
          <Allocated>decimal</Allocated>
          <Award>
            <ChildMarkCodes>string</ChildMarkCodes>
            <Distributions xsi:nil="true" />
            <Fund xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <StudyTitle>string</StudyTitle>
            <StudyCode>string</StudyCode>
            <TotalAward>decimal</TotalAward>
            <AwdAlertKey>int</AwdAlertKey>
            <AwdNote>string</AwdNote>
            <PPAddress>string</PPAddress>
            <PPName>string</PPName>
            <CreditAmt>decimal</CreditAmt>
            <Status>string</Status>
            <Number>string</Number>
            <AwdImportKey>int</AwdImportKey>
            <AwardID>int</AwardID>
            <ClassStudentID>int</ClassStudentID>
            <PersonID>int</PersonID>
            <PathStudentID>int</PathStudentID>
            <FundID>int</FundID>
          </Award>
          <BatchStatusID>int</BatchStatusID>
          <FunAccountID>int</FunAccountID>
          <FunCode>string</FunCode>
          <FundID>int</FundID>
          <FunName>string</FunName>
          <MarkerCodes>string</MarkerCodes>
          <Sales>
            <Sales xsi:nil="true" />
            <Sales xsi:nil="true" />
          </Sales>
          <DistFAFlag>
            <DistFAFlag xsi:nil="true" />
            <DistFAFlag xsi:nil="true" />
          </DistFAFlag>
          <StatusID>int</StatusID>
          <StudentCode>string</StudentCode>
          <StudentName>string</StudentName>
          <StudentSSN>string</StudentSSN>
          <disNote>string</disNote>
          <DistributionID>int</DistributionID>
          <AmtStudent>decimal</AmtStudent>
          <disAlertKey>int</disAlertKey>
          <TransCode>string</TransCode>
          <disImportKey>int</disImportKey>
          <BatchCode>string</BatchCode>
          <AmountLoan>decimal</AmountLoan>
          <AwardID>int</AwardID>
          <Number>int</Number>
          <PercentFee>decimal</PercentFee>
          <AmountTotal>decimal</AmountTotal>
          <AvailableDate>dateTime</AvailableDate>
          <AmountFee>decimal</AmountFee>
        </Distribution>
        <Distribution>
          <Allocated>decimal</Allocated>
          <Award>
            <ChildMarkCodes>string</ChildMarkCodes>
            <Distributions xsi:nil="true" />
            <Fund xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <StudyTitle>string</StudyTitle>
            <StudyCode>string</StudyCode>
            <TotalAward>decimal</TotalAward>
            <AwdAlertKey>int</AwdAlertKey>
            <AwdNote>string</AwdNote>
            <PPAddress>string</PPAddress>
            <PPName>string</PPName>
            <CreditAmt>decimal</CreditAmt>
            <Status>string</Status>
            <Number>string</Number>
            <AwdImportKey>int</AwdImportKey>
            <AwardID>int</AwardID>
            <ClassStudentID>int</ClassStudentID>
            <PersonID>int</PersonID>
            <PathStudentID>int</PathStudentID>
            <FundID>int</FundID>
          </Award>
          <BatchStatusID>int</BatchStatusID>
          <FunAccountID>int</FunAccountID>
          <FunCode>string</FunCode>
          <FundID>int</FundID>
          <FunName>string</FunName>
          <MarkerCodes>string</MarkerCodes>
          <Sales>
            <Sales xsi:nil="true" />
            <Sales xsi:nil="true" />
          </Sales>
          <DistFAFlag>
            <DistFAFlag xsi:nil="true" />
            <DistFAFlag xsi:nil="true" />
          </DistFAFlag>
          <StatusID>int</StatusID>
          <StudentCode>string</StudentCode>
          <StudentName>string</StudentName>
          <StudentSSN>string</StudentSSN>
          <disNote>string</disNote>
          <DistributionID>int</DistributionID>
          <AmtStudent>decimal</AmtStudent>
          <disAlertKey>int</disAlertKey>
          <TransCode>string</TransCode>
          <disImportKey>int</disImportKey>
          <BatchCode>string</BatchCode>
          <AmountLoan>decimal</AmountLoan>
          <AwardID>int</AwardID>
          <Number>int</Number>
          <PercentFee>decimal</PercentFee>
          <AmountTotal>decimal</AmountTotal>
          <AvailableDate>dateTime</AvailableDate>
          <AmountFee>decimal</AmountFee>
        </Distribution>
      </SelectDistributionQuickResult>
    </SelectDistributionQuickResponse>
  </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>
    <SelectDistributionQuick xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </SelectDistributionQuick>
  </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>
    <SelectDistributionQuickResponse xmlns="http://www.Achademix.com/">
      <SelectDistributionQuickResult>
        <Distribution>
          <Allocated>decimal</Allocated>
          <Award>
            <ChildMarkCodes>string</ChildMarkCodes>
            <Distributions xsi:nil="true" />
            <Fund xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <StudyTitle>string</StudyTitle>
            <StudyCode>string</StudyCode>
            <TotalAward>decimal</TotalAward>
            <AwdAlertKey>int</AwdAlertKey>
            <AwdNote>string</AwdNote>
            <PPAddress>string</PPAddress>
            <PPName>string</PPName>
            <CreditAmt>decimal</CreditAmt>
            <Status>string</Status>
            <Number>string</Number>
            <AwdImportKey>int</AwdImportKey>
            <AwardID>int</AwardID>
            <ClassStudentID>int</ClassStudentID>
            <PersonID>int</PersonID>
            <PathStudentID>int</PathStudentID>
            <FundID>int</FundID>
          </Award>
          <BatchStatusID>int</BatchStatusID>
          <FunAccountID>int</FunAccountID>
          <FunCode>string</FunCode>
          <FundID>int</FundID>
          <FunName>string</FunName>
          <MarkerCodes>string</MarkerCodes>
          <Sales>
            <Sales xsi:nil="true" />
            <Sales xsi:nil="true" />
          </Sales>
          <DistFAFlag>
            <DistFAFlag xsi:nil="true" />
            <DistFAFlag xsi:nil="true" />
          </DistFAFlag>
          <StatusID>int</StatusID>
          <StudentCode>string</StudentCode>
          <StudentName>string</StudentName>
          <StudentSSN>string</StudentSSN>
          <disNote>string</disNote>
          <DistributionID>int</DistributionID>
          <AmtStudent>decimal</AmtStudent>
          <disAlertKey>int</disAlertKey>
          <TransCode>string</TransCode>
          <disImportKey>int</disImportKey>
          <BatchCode>string</BatchCode>
          <AmountLoan>decimal</AmountLoan>
          <AwardID>int</AwardID>
          <Number>int</Number>
          <PercentFee>decimal</PercentFee>
          <AmountTotal>decimal</AmountTotal>
          <AvailableDate>dateTime</AvailableDate>
          <AmountFee>decimal</AmountFee>
        </Distribution>
        <Distribution>
          <Allocated>decimal</Allocated>
          <Award>
            <ChildMarkCodes>string</ChildMarkCodes>
            <Distributions xsi:nil="true" />
            <Fund xsi:nil="true" />
            <StartDate>dateTime</StartDate>
            <StudyTitle>string</StudyTitle>
            <StudyCode>string</StudyCode>
            <TotalAward>decimal</TotalAward>
            <AwdAlertKey>int</AwdAlertKey>
            <AwdNote>string</AwdNote>
            <PPAddress>string</PPAddress>
            <PPName>string</PPName>
            <CreditAmt>decimal</CreditAmt>
            <Status>string</Status>
            <Number>string</Number>
            <AwdImportKey>int</AwdImportKey>
            <AwardID>int</AwardID>
            <ClassStudentID>int</ClassStudentID>
            <PersonID>int</PersonID>
            <PathStudentID>int</PathStudentID>
            <FundID>int</FundID>
          </Award>
          <BatchStatusID>int</BatchStatusID>
          <FunAccountID>int</FunAccountID>
          <FunCode>string</FunCode>
          <FundID>int</FundID>
          <FunName>string</FunName>
          <MarkerCodes>string</MarkerCodes>
          <Sales>
            <Sales xsi:nil="true" />
            <Sales xsi:nil="true" />
          </Sales>
          <DistFAFlag>
            <DistFAFlag xsi:nil="true" />
            <DistFAFlag xsi:nil="true" />
          </DistFAFlag>
          <StatusID>int</StatusID>
          <StudentCode>string</StudentCode>
          <StudentName>string</StudentName>
          <StudentSSN>string</StudentSSN>
          <disNote>string</disNote>
          <DistributionID>int</DistributionID>
          <AmtStudent>decimal</AmtStudent>
          <disAlertKey>int</disAlertKey>
          <TransCode>string</TransCode>
          <disImportKey>int</disImportKey>
          <BatchCode>string</BatchCode>
          <AmountLoan>decimal</AmountLoan>
          <AwardID>int</AwardID>
          <Number>int</Number>
          <PercentFee>decimal</PercentFee>
          <AmountTotal>decimal</AmountTotal>
          <AvailableDate>dateTime</AvailableDate>
          <AmountFee>decimal</AmountFee>
        </Distribution>
      </SelectDistributionQuickResult>
    </SelectDistributionQuickResponse>
  </soap12:Body>
</soap12:Envelope>