AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SaveDistribution

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

<?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>
    <SaveDistribution xmlns="http://www.Achademix.com/">
      <TheTable>
        <Allocated>decimal</Allocated>
        <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>
        <BatchStatusID>int</BatchStatusID>
        <FunAccountID>int</FunAccountID>
        <FunCode>string</FunCode>
        <FundID>int</FundID>
        <FunName>string</FunName>
        <MarkerCodes>string</MarkerCodes>
        <Sales>
          <Sales>
            <Code>string</Code>
            <InvGroupData>string</InvGroupData>
            <LedgerCode>string</LedgerCode>
            <PayPeriod>int</PayPeriod>
            <SaleTicket xsi:nil="true" />
            <Adjustments xsi:nil="true" />
            <Allocations xsi:nil="true" />
            <EnableCalculation>boolean</EnableCalculation>
            <InvoiceNum>string</InvoiceNum>
            <NewAllocation>decimal</NewAllocation>
            <SaleName>string</SaleName>
            <TicketAss>string</TicketAss>
            <TicketAttn>string</TicketAttn>
            <TicketHistory>string</TicketHistory>
            <TicketLastPrt>dateTime</TicketLastPrt>
            <TicketNote>string</TicketNote>
            <TicketNum>string</TicketNum>
            <TicketPaid>int</TicketPaid>
            <TicketPersonID>int</TicketPersonID>
            <TicketPrtCnt>int</TicketPrtCnt>
            <TicketTerms>string</TicketTerms>
            <TicketTitle>string</TicketTitle>
            <TypeTitle>string</TypeTitle>
            <BatchCode>string</BatchCode>
            <DueDate>dateTime</DueDate>
            <ItemID>int</ItemID>
            <SalesID>int</SalesID>
            <SalSourceID>int</SalSourceID>
            <SalTypeID>int</SalTypeID>
            <ServiceID>int</ServiceID>
            <TaxRate>decimal</TaxRate>
            <TicketID>int</TicketID>
            <Quantity>decimal</Quantity>
            <UnitAmount>decimal</UnitAmount>
            <TaxAmount>decimal</TaxAmount>
            <TotalAmount>decimal</TotalAmount>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Sales>
          <Sales>
            <Code>string</Code>
            <InvGroupData>string</InvGroupData>
            <LedgerCode>string</LedgerCode>
            <PayPeriod>int</PayPeriod>
            <SaleTicket xsi:nil="true" />
            <Adjustments xsi:nil="true" />
            <Allocations xsi:nil="true" />
            <EnableCalculation>boolean</EnableCalculation>
            <InvoiceNum>string</InvoiceNum>
            <NewAllocation>decimal</NewAllocation>
            <SaleName>string</SaleName>
            <TicketAss>string</TicketAss>
            <TicketAttn>string</TicketAttn>
            <TicketHistory>string</TicketHistory>
            <TicketLastPrt>dateTime</TicketLastPrt>
            <TicketNote>string</TicketNote>
            <TicketNum>string</TicketNum>
            <TicketPaid>int</TicketPaid>
            <TicketPersonID>int</TicketPersonID>
            <TicketPrtCnt>int</TicketPrtCnt>
            <TicketTerms>string</TicketTerms>
            <TicketTitle>string</TicketTitle>
            <TypeTitle>string</TypeTitle>
            <BatchCode>string</BatchCode>
            <DueDate>dateTime</DueDate>
            <ItemID>int</ItemID>
            <SalesID>int</SalesID>
            <SalSourceID>int</SalSourceID>
            <SalTypeID>int</SalTypeID>
            <ServiceID>int</ServiceID>
            <TaxRate>decimal</TaxRate>
            <TicketID>int</TicketID>
            <Quantity>decimal</Quantity>
            <UnitAmount>decimal</UnitAmount>
            <TaxAmount>decimal</TaxAmount>
            <TotalAmount>decimal</TotalAmount>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Sales>
        </Sales>
        <DistFAFlag>
          <DistFAFlag>
            <FAFlags xsi:nil="true" />
            <DistributionID>int</DistributionID>
            <DistFAFlagID>int</DistFAFlagID>
            <FAFlagListID>int</FAFlagListID>
          </DistFAFlag>
          <DistFAFlag>
            <FAFlags xsi:nil="true" />
            <DistributionID>int</DistributionID>
            <DistFAFlagID>int</DistFAFlagID>
            <FAFlagListID>int</FAFlagListID>
          </DistFAFlag>
        </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>
      </TheTable>
    </SaveDistribution>
  </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>
    <SaveDistributionResponse xmlns="http://www.Achademix.com/">
      <SaveDistributionResult>int</SaveDistributionResult>
    </SaveDistributionResponse>
  </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>
    <SaveDistribution xmlns="http://www.Achademix.com/">
      <TheTable>
        <Allocated>decimal</Allocated>
        <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>
        <BatchStatusID>int</BatchStatusID>
        <FunAccountID>int</FunAccountID>
        <FunCode>string</FunCode>
        <FundID>int</FundID>
        <FunName>string</FunName>
        <MarkerCodes>string</MarkerCodes>
        <Sales>
          <Sales>
            <Code>string</Code>
            <InvGroupData>string</InvGroupData>
            <LedgerCode>string</LedgerCode>
            <PayPeriod>int</PayPeriod>
            <SaleTicket xsi:nil="true" />
            <Adjustments xsi:nil="true" />
            <Allocations xsi:nil="true" />
            <EnableCalculation>boolean</EnableCalculation>
            <InvoiceNum>string</InvoiceNum>
            <NewAllocation>decimal</NewAllocation>
            <SaleName>string</SaleName>
            <TicketAss>string</TicketAss>
            <TicketAttn>string</TicketAttn>
            <TicketHistory>string</TicketHistory>
            <TicketLastPrt>dateTime</TicketLastPrt>
            <TicketNote>string</TicketNote>
            <TicketNum>string</TicketNum>
            <TicketPaid>int</TicketPaid>
            <TicketPersonID>int</TicketPersonID>
            <TicketPrtCnt>int</TicketPrtCnt>
            <TicketTerms>string</TicketTerms>
            <TicketTitle>string</TicketTitle>
            <TypeTitle>string</TypeTitle>
            <BatchCode>string</BatchCode>
            <DueDate>dateTime</DueDate>
            <ItemID>int</ItemID>
            <SalesID>int</SalesID>
            <SalSourceID>int</SalSourceID>
            <SalTypeID>int</SalTypeID>
            <ServiceID>int</ServiceID>
            <TaxRate>decimal</TaxRate>
            <TicketID>int</TicketID>
            <Quantity>decimal</Quantity>
            <UnitAmount>decimal</UnitAmount>
            <TaxAmount>decimal</TaxAmount>
            <TotalAmount>decimal</TotalAmount>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Sales>
          <Sales>
            <Code>string</Code>
            <InvGroupData>string</InvGroupData>
            <LedgerCode>string</LedgerCode>
            <PayPeriod>int</PayPeriod>
            <SaleTicket xsi:nil="true" />
            <Adjustments xsi:nil="true" />
            <Allocations xsi:nil="true" />
            <EnableCalculation>boolean</EnableCalculation>
            <InvoiceNum>string</InvoiceNum>
            <NewAllocation>decimal</NewAllocation>
            <SaleName>string</SaleName>
            <TicketAss>string</TicketAss>
            <TicketAttn>string</TicketAttn>
            <TicketHistory>string</TicketHistory>
            <TicketLastPrt>dateTime</TicketLastPrt>
            <TicketNote>string</TicketNote>
            <TicketNum>string</TicketNum>
            <TicketPaid>int</TicketPaid>
            <TicketPersonID>int</TicketPersonID>
            <TicketPrtCnt>int</TicketPrtCnt>
            <TicketTerms>string</TicketTerms>
            <TicketTitle>string</TicketTitle>
            <TypeTitle>string</TypeTitle>
            <BatchCode>string</BatchCode>
            <DueDate>dateTime</DueDate>
            <ItemID>int</ItemID>
            <SalesID>int</SalesID>
            <SalSourceID>int</SalSourceID>
            <SalTypeID>int</SalTypeID>
            <ServiceID>int</ServiceID>
            <TaxRate>decimal</TaxRate>
            <TicketID>int</TicketID>
            <Quantity>decimal</Quantity>
            <UnitAmount>decimal</UnitAmount>
            <TaxAmount>decimal</TaxAmount>
            <TotalAmount>decimal</TotalAmount>
            <IsTaxExempt>boolean</IsTaxExempt>
          </Sales>
        </Sales>
        <DistFAFlag>
          <DistFAFlag>
            <FAFlags xsi:nil="true" />
            <DistributionID>int</DistributionID>
            <DistFAFlagID>int</DistFAFlagID>
            <FAFlagListID>int</FAFlagListID>
          </DistFAFlag>
          <DistFAFlag>
            <FAFlags xsi:nil="true" />
            <DistributionID>int</DistributionID>
            <DistFAFlagID>int</DistFAFlagID>
            <FAFlagListID>int</FAFlagListID>
          </DistFAFlag>
        </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>
      </TheTable>
    </SaveDistribution>
  </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>
    <SaveDistributionResponse xmlns="http://www.Achademix.com/">
      <SaveDistributionResult>int</SaveDistributionResult>
    </SaveDistributionResponse>
  </soap12:Body>
</soap12:Envelope>