AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SelectAwardQuick

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

<?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>
    <SelectAwardQuick xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </SelectAwardQuick>
  </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>
    <SelectAwardQuickResponse xmlns="http://www.Achademix.com/">
      <SelectAwardQuickResult>
        <Award>
          <ChildMarkCodes>string</ChildMarkCodes>
          <Distributions>
            <Distribution xsi:nil="true" />
            <Distribution xsi:nil="true" />
          </Distributions>
          <Fund>
            <ContactPeople xsi:nil="true" />
            <AddressList xsi:nil="true" />
            <CategoryCode>string</CategoryCode>
            <CategoryTitle>string</CategoryTitle>
            <Documents xsi:nil="true" />
            <FundAddress xsi:nil="true" />
            <FundCreditLimit>decimal</FundCreditLimit>
            <FundPerson xsi:nil="true" />
            <GroupCode>string</GroupCode>
            <GroupTitle>string</GroupTitle>
            <LedgerCode>string</LedgerCode>
            <LedgerTitle>string</LedgerTitle>
            <StatusCode>string</StatusCode>
            <StatusTitle>string</StatusTitle>
            <Summary xsi:nil="true" />
            <PostaNotes xsi:nil="true" />
            <AccountID>int</AccountID>
            <AlertLevel>int</AlertLevel>
            <Availability>int</Availability>
            <FeePercent>decimal</FeePercent>
            <AwardYear>int</AwardYear>
            <FunCategoryListID>int</FunCategoryListID>
            <Code>string</Code>
            <FundID>int</FundID>
            <FunGroupListID>int</FunGroupListID>
            <ImportKey>int</ImportKey>
            <CanPassCredit>boolean</CanPassCredit>
            <MaxAwardAmt>decimal</MaxAwardAmt>
            <Name>string</Name>
            <FunStatusID>int</FunStatusID>
            <Note>string</Note>
            <ServiceID>int</ServiceID>
            <UserData>string</UserData>
            <LedgerID>int</LedgerID>
            <SchoolID>int</SchoolID>
            <VendorCode>string</VendorCode>
            <G5AwardNum>string</G5AwardNum>
            <EIN>string</EIN>
          </Fund>
          <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>
        <Award>
          <ChildMarkCodes>string</ChildMarkCodes>
          <Distributions>
            <Distribution xsi:nil="true" />
            <Distribution xsi:nil="true" />
          </Distributions>
          <Fund>
            <ContactPeople xsi:nil="true" />
            <AddressList xsi:nil="true" />
            <CategoryCode>string</CategoryCode>
            <CategoryTitle>string</CategoryTitle>
            <Documents xsi:nil="true" />
            <FundAddress xsi:nil="true" />
            <FundCreditLimit>decimal</FundCreditLimit>
            <FundPerson xsi:nil="true" />
            <GroupCode>string</GroupCode>
            <GroupTitle>string</GroupTitle>
            <LedgerCode>string</LedgerCode>
            <LedgerTitle>string</LedgerTitle>
            <StatusCode>string</StatusCode>
            <StatusTitle>string</StatusTitle>
            <Summary xsi:nil="true" />
            <PostaNotes xsi:nil="true" />
            <AccountID>int</AccountID>
            <AlertLevel>int</AlertLevel>
            <Availability>int</Availability>
            <FeePercent>decimal</FeePercent>
            <AwardYear>int</AwardYear>
            <FunCategoryListID>int</FunCategoryListID>
            <Code>string</Code>
            <FundID>int</FundID>
            <FunGroupListID>int</FunGroupListID>
            <ImportKey>int</ImportKey>
            <CanPassCredit>boolean</CanPassCredit>
            <MaxAwardAmt>decimal</MaxAwardAmt>
            <Name>string</Name>
            <FunStatusID>int</FunStatusID>
            <Note>string</Note>
            <ServiceID>int</ServiceID>
            <UserData>string</UserData>
            <LedgerID>int</LedgerID>
            <SchoolID>int</SchoolID>
            <VendorCode>string</VendorCode>
            <G5AwardNum>string</G5AwardNum>
            <EIN>string</EIN>
          </Fund>
          <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>
      </SelectAwardQuickResult>
    </SelectAwardQuickResponse>
  </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>
    <SelectAwardQuick xmlns="http://www.Achademix.com/">
      <SearchString>string</SearchString>
    </SelectAwardQuick>
  </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>
    <SelectAwardQuickResponse xmlns="http://www.Achademix.com/">
      <SelectAwardQuickResult>
        <Award>
          <ChildMarkCodes>string</ChildMarkCodes>
          <Distributions>
            <Distribution xsi:nil="true" />
            <Distribution xsi:nil="true" />
          </Distributions>
          <Fund>
            <ContactPeople xsi:nil="true" />
            <AddressList xsi:nil="true" />
            <CategoryCode>string</CategoryCode>
            <CategoryTitle>string</CategoryTitle>
            <Documents xsi:nil="true" />
            <FundAddress xsi:nil="true" />
            <FundCreditLimit>decimal</FundCreditLimit>
            <FundPerson xsi:nil="true" />
            <GroupCode>string</GroupCode>
            <GroupTitle>string</GroupTitle>
            <LedgerCode>string</LedgerCode>
            <LedgerTitle>string</LedgerTitle>
            <StatusCode>string</StatusCode>
            <StatusTitle>string</StatusTitle>
            <Summary xsi:nil="true" />
            <PostaNotes xsi:nil="true" />
            <AccountID>int</AccountID>
            <AlertLevel>int</AlertLevel>
            <Availability>int</Availability>
            <FeePercent>decimal</FeePercent>
            <AwardYear>int</AwardYear>
            <FunCategoryListID>int</FunCategoryListID>
            <Code>string</Code>
            <FundID>int</FundID>
            <FunGroupListID>int</FunGroupListID>
            <ImportKey>int</ImportKey>
            <CanPassCredit>boolean</CanPassCredit>
            <MaxAwardAmt>decimal</MaxAwardAmt>
            <Name>string</Name>
            <FunStatusID>int</FunStatusID>
            <Note>string</Note>
            <ServiceID>int</ServiceID>
            <UserData>string</UserData>
            <LedgerID>int</LedgerID>
            <SchoolID>int</SchoolID>
            <VendorCode>string</VendorCode>
            <G5AwardNum>string</G5AwardNum>
            <EIN>string</EIN>
          </Fund>
          <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>
        <Award>
          <ChildMarkCodes>string</ChildMarkCodes>
          <Distributions>
            <Distribution xsi:nil="true" />
            <Distribution xsi:nil="true" />
          </Distributions>
          <Fund>
            <ContactPeople xsi:nil="true" />
            <AddressList xsi:nil="true" />
            <CategoryCode>string</CategoryCode>
            <CategoryTitle>string</CategoryTitle>
            <Documents xsi:nil="true" />
            <FundAddress xsi:nil="true" />
            <FundCreditLimit>decimal</FundCreditLimit>
            <FundPerson xsi:nil="true" />
            <GroupCode>string</GroupCode>
            <GroupTitle>string</GroupTitle>
            <LedgerCode>string</LedgerCode>
            <LedgerTitle>string</LedgerTitle>
            <StatusCode>string</StatusCode>
            <StatusTitle>string</StatusTitle>
            <Summary xsi:nil="true" />
            <PostaNotes xsi:nil="true" />
            <AccountID>int</AccountID>
            <AlertLevel>int</AlertLevel>
            <Availability>int</Availability>
            <FeePercent>decimal</FeePercent>
            <AwardYear>int</AwardYear>
            <FunCategoryListID>int</FunCategoryListID>
            <Code>string</Code>
            <FundID>int</FundID>
            <FunGroupListID>int</FunGroupListID>
            <ImportKey>int</ImportKey>
            <CanPassCredit>boolean</CanPassCredit>
            <MaxAwardAmt>decimal</MaxAwardAmt>
            <Name>string</Name>
            <FunStatusID>int</FunStatusID>
            <Note>string</Note>
            <ServiceID>int</ServiceID>
            <UserData>string</UserData>
            <LedgerID>int</LedgerID>
            <SchoolID>int</SchoolID>
            <VendorCode>string</VendorCode>
            <G5AwardNum>string</G5AwardNum>
            <EIN>string</EIN>
          </Fund>
          <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>
      </SelectAwardQuickResult>
    </SelectAwardQuickResponse>
  </soap12:Body>
</soap12:Envelope>