Vend


Click here for a complete list of operations.

authenticate_cashier

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 /vend.asmx HTTP/1.1
Host: ws.marblegold.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/authenticate_cashier"

<?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:Body>
    <authenticate_cashier xmlns="http://tempuri.org/">
      <terminalnumber>string</terminalnumber>
      <msisdn>string</msisdn>
      <pin>string</pin>
    </authenticate_cashier>
  </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:Body>
    <authenticate_cashierResponse xmlns="http://tempuri.org/">
      <authenticate_cashierResult>
        <HasActiveShift>boolean</HasActiveShift>
        <Id>int</Id>
        <Vendor>
          <Adds>boolean</Adds>
          <Email>string</Email>
          <IdNumber>string</IdNumber>
          <RetailGroupId>int</RetailGroupId>
          <VendorName>string</VendorName>
          <VendorId>int</VendorId>
          <Balance>
            <Available>decimal</Available>
            <Current>decimal</Current>
            <CreditLimit>decimal</CreditLimit>
          </Balance>
          <DepositIdentifier>string</DepositIdentifier>
          <LastFullReportSeq>int</LastFullReportSeq>
          <LastFullReportDate>dateTime</LastFullReportDate>
          <AdditionalData>
            <AdditionalData xsi:nil="true" />
            <AdditionalData xsi:nil="true" />
          </AdditionalData>
        </Vendor>
        <CashierName>string</CashierName>
        <Pin>string</Pin>
        <IsAdministrator>boolean</IsAdministrator>
        <Status>int</Status>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <ShiftSeq>int</ShiftSeq>
      </authenticate_cashierResult>
      <token>string</token>
      <error>string</error>
    </authenticate_cashierResponse>
  </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 /vend.asmx HTTP/1.1
Host: ws.marblegold.co.za
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:Body>
    <authenticate_cashier xmlns="http://tempuri.org/">
      <terminalnumber>string</terminalnumber>
      <msisdn>string</msisdn>
      <pin>string</pin>
    </authenticate_cashier>
  </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:Body>
    <authenticate_cashierResponse xmlns="http://tempuri.org/">
      <authenticate_cashierResult>
        <HasActiveShift>boolean</HasActiveShift>
        <Id>int</Id>
        <Vendor>
          <Adds>boolean</Adds>
          <Email>string</Email>
          <IdNumber>string</IdNumber>
          <RetailGroupId>int</RetailGroupId>
          <VendorName>string</VendorName>
          <VendorId>int</VendorId>
          <Balance>
            <Available>decimal</Available>
            <Current>decimal</Current>
            <CreditLimit>decimal</CreditLimit>
          </Balance>
          <DepositIdentifier>string</DepositIdentifier>
          <LastFullReportSeq>int</LastFullReportSeq>
          <LastFullReportDate>dateTime</LastFullReportDate>
          <AdditionalData>
            <AdditionalData xsi:nil="true" />
            <AdditionalData xsi:nil="true" />
          </AdditionalData>
        </Vendor>
        <CashierName>string</CashierName>
        <Pin>string</Pin>
        <IsAdministrator>boolean</IsAdministrator>
        <Status>int</Status>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <ShiftSeq>int</ShiftSeq>
      </authenticate_cashierResult>
      <token>string</token>
      <error>string</error>
    </authenticate_cashierResponse>
  </soap12:Body>
</soap12:Envelope>