AchademixWS Web Service

AchademixWS

Click here for a complete list of operations.

SaveAllocation

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

<?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>
    <SaveAllocation xmlns="http://www.Achademix.com/">
      <TheTable>
        <Payment>
          <AwardDueDate>dateTime</AwardDueDate>
          <BatchCode>string</BatchCode>
          <SetAccountStatus>int</SetAccountStatus>
          <TransferFromAccount>int</TransferFromAccount>
          <Allocations>
            <Allocation xsi:nil="true" />
            <Allocation xsi:nil="true" />
          </Allocations>
          <BatchNum>int</BatchNum>
          <CardTitle>string</CardTitle>
          <Refunds>
            <Refund xsi:nil="true" />
            <Refund xsi:nil="true" />
          </Refunds>
          <TrmImportKey>int</TrmImportKey>
          <TypeTitle>string</TypeTitle>
          <AccountAddress>string</AccountAddress>
          <CCHolder>string</CCHolder>
          <CreditCardListID>int</CreditCardListID>
          <DistributionID>int</DistributionID>
          <PayAmount>decimal</PayAmount>
          <CCExpire>string</CCExpire>
          <CCNumber>string</CCNumber>
          <CheckNumber>string</CheckNumber>
          <IsAllocated>boolean</IsAllocated>
          <PaymentsID>int</PaymentsID>
          <Note>string</Note>
          <Reference>string</Reference>
          <PayTypeID>int</PayTypeID>
          <PrintCount>int</PrintCount>
          <ZoutID>int</ZoutID>
          <ReceiptNumber>string</ReceiptNumber>
        </Payment>
        <RefundAmount>decimal</RefundAmount>
        <RefundedAmount>decimal</RefundedAmount>
        <Sale>
          <Code>string</Code>
          <InvGroupData>string</InvGroupData>
          <LedgerCode>string</LedgerCode>
          <PayPeriod>int</PayPeriod>
          <SaleTicket>
            <PayPlans xsi:nil="true" />
            <Attention>string</Attention>
            <ClassID>int</ClassID>
            <InvGrpData>string</InvGrpData>
            <InvoiceNumber>string</InvoiceNumber>
            <ImportKey>int</ImportKey>
            <LastPrtDate>dateTime</LastPrtDate>
            <Paid>int</Paid>
            <IssueDate>dateTime</IssueDate>
            <PersonID>int</PersonID>
            <PrintCount>int</PrintCount>
            <TicketID>int</TicketID>
            <TicketNumber>string</TicketNumber>
            <Mode>int</Mode>
            <Note>string</Note>
            <Terms>string</Terms>
            <Title>string</Title>
          </SaleTicket>
          <Adjustments>
            <Adjustment xsi:nil="true" />
            <Adjustment xsi:nil="true" />
          </Adjustments>
          <Allocations>
            <Allocation xsi:nil="true" />
            <Allocation xsi:nil="true" />
          </Allocations>
          <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>
        </Sale>
        <Ticket>
          <PayPlans>
            <PayPlan xsi:nil="true" />
            <PayPlan xsi:nil="true" />
          </PayPlans>
          <Attention>string</Attention>
          <ClassID>int</ClassID>
          <InvGrpData>string</InvGrpData>
          <InvoiceNumber>string</InvoiceNumber>
          <ImportKey>int</ImportKey>
          <LastPrtDate>dateTime</LastPrtDate>
          <Paid>int</Paid>
          <IssueDate>dateTime</IssueDate>
          <PersonID>int</PersonID>
          <PrintCount>int</PrintCount>
          <TicketID>int</TicketID>
          <TicketNumber>string</TicketNumber>
          <Mode>int</Mode>
          <Note>string</Note>
          <Terms>string</Terms>
          <Title>string</Title>
        </Ticket>
        <PayReference>string</PayReference>
        <ReceiptNumber>string</ReceiptNumber>
        <Amount>decimal</Amount>
        <AllocationID>int</AllocationID>
        <PaymentsID>int</PaymentsID>
        <SalesID>int</SalesID>
        <ImportKey>int</ImportKey>
      </TheTable>
    </SaveAllocation>
  </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>
    <SaveAllocationResponse xmlns="http://www.Achademix.com/">
      <SaveAllocationResult>int</SaveAllocationResult>
    </SaveAllocationResponse>
  </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>
    <SaveAllocation xmlns="http://www.Achademix.com/">
      <TheTable>
        <Payment>
          <AwardDueDate>dateTime</AwardDueDate>
          <BatchCode>string</BatchCode>
          <SetAccountStatus>int</SetAccountStatus>
          <TransferFromAccount>int</TransferFromAccount>
          <Allocations>
            <Allocation xsi:nil="true" />
            <Allocation xsi:nil="true" />
          </Allocations>
          <BatchNum>int</BatchNum>
          <CardTitle>string</CardTitle>
          <Refunds>
            <Refund xsi:nil="true" />
            <Refund xsi:nil="true" />
          </Refunds>
          <TrmImportKey>int</TrmImportKey>
          <TypeTitle>string</TypeTitle>
          <AccountAddress>string</AccountAddress>
          <CCHolder>string</CCHolder>
          <CreditCardListID>int</CreditCardListID>
          <DistributionID>int</DistributionID>
          <PayAmount>decimal</PayAmount>
          <CCExpire>string</CCExpire>
          <CCNumber>string</CCNumber>
          <CheckNumber>string</CheckNumber>
          <IsAllocated>boolean</IsAllocated>
          <PaymentsID>int</PaymentsID>
          <Note>string</Note>
          <Reference>string</Reference>
          <PayTypeID>int</PayTypeID>
          <PrintCount>int</PrintCount>
          <ZoutID>int</ZoutID>
          <ReceiptNumber>string</ReceiptNumber>
        </Payment>
        <RefundAmount>decimal</RefundAmount>
        <RefundedAmount>decimal</RefundedAmount>
        <Sale>
          <Code>string</Code>
          <InvGroupData>string</InvGroupData>
          <LedgerCode>string</LedgerCode>
          <PayPeriod>int</PayPeriod>
          <SaleTicket>
            <PayPlans xsi:nil="true" />
            <Attention>string</Attention>
            <ClassID>int</ClassID>
            <InvGrpData>string</InvGrpData>
            <InvoiceNumber>string</InvoiceNumber>
            <ImportKey>int</ImportKey>
            <LastPrtDate>dateTime</LastPrtDate>
            <Paid>int</Paid>
            <IssueDate>dateTime</IssueDate>
            <PersonID>int</PersonID>
            <PrintCount>int</PrintCount>
            <TicketID>int</TicketID>
            <TicketNumber>string</TicketNumber>
            <Mode>int</Mode>
            <Note>string</Note>
            <Terms>string</Terms>
            <Title>string</Title>
          </SaleTicket>
          <Adjustments>
            <Adjustment xsi:nil="true" />
            <Adjustment xsi:nil="true" />
          </Adjustments>
          <Allocations>
            <Allocation xsi:nil="true" />
            <Allocation xsi:nil="true" />
          </Allocations>
          <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>
        </Sale>
        <Ticket>
          <PayPlans>
            <PayPlan xsi:nil="true" />
            <PayPlan xsi:nil="true" />
          </PayPlans>
          <Attention>string</Attention>
          <ClassID>int</ClassID>
          <InvGrpData>string</InvGrpData>
          <InvoiceNumber>string</InvoiceNumber>
          <ImportKey>int</ImportKey>
          <LastPrtDate>dateTime</LastPrtDate>
          <Paid>int</Paid>
          <IssueDate>dateTime</IssueDate>
          <PersonID>int</PersonID>
          <PrintCount>int</PrintCount>
          <TicketID>int</TicketID>
          <TicketNumber>string</TicketNumber>
          <Mode>int</Mode>
          <Note>string</Note>
          <Terms>string</Terms>
          <Title>string</Title>
        </Ticket>
        <PayReference>string</PayReference>
        <ReceiptNumber>string</ReceiptNumber>
        <Amount>decimal</Amount>
        <AllocationID>int</AllocationID>
        <PaymentsID>int</PaymentsID>
        <SalesID>int</SalesID>
        <ImportKey>int</ImportKey>
      </TheTable>
    </SaveAllocation>
  </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>
    <SaveAllocationResponse xmlns="http://www.Achademix.com/">
      <SaveAllocationResult>int</SaveAllocationResult>
    </SaveAllocationResponse>
  </soap12:Body>
</soap12:Envelope>