DC_Catering Web Service

DC_Catering

Click here for a complete list of operations.

GetCustomers

Get a list of customers.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
CustomerID:
ExternalCustomerID:
Description:
Phone:

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 /Web1243/services/DC_Catering.asmx HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://restaurantmagic.com/services/GetCustomers"

<?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>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap:Header>
  <soap:Body>
    <GetCustomers xmlns="http://restaurantmagic.com/services">
      <CustomerID>string</CustomerID>
      <ExternalCustomerID>string</ExternalCustomerID>
      <Description>string</Description>
      <Phone>string</Phone>
    </GetCustomers>
  </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>
    <GetCustomersResponse xmlns="http://restaurantmagic.com/services">
      <GetCustomersResult>
        <TCustomers>
          <CustomerID>string</CustomerID>
          <BillToCode>string</BillToCode>
          <Description>string</Description>
          <Type>string</Type>
          <Usage>string</Usage>
          <Hide>boolean</Hide>
          <Group1>string</Group1>
          <Group2>string</Group2>
          <Group3>string</Group3>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <ContactName>string</ContactName>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Fax>string</Fax>
          <Email>string</Email>
          <WebSite>string</WebSite>
          <CustomerUnit>string</CustomerUnit>
          <SalesAccount>string</SalesAccount>
          <PaymentAccount>string</PaymentAccount>
          <CashPaymentAccount>string</CashPaymentAccount>
          <AccountingMethod>string</AccountingMethod>
          <ExternalCustomerID>string</ExternalCustomerID>
        </TCustomers>
        <TCustomers>
          <CustomerID>string</CustomerID>
          <BillToCode>string</BillToCode>
          <Description>string</Description>
          <Type>string</Type>
          <Usage>string</Usage>
          <Hide>boolean</Hide>
          <Group1>string</Group1>
          <Group2>string</Group2>
          <Group3>string</Group3>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <ContactName>string</ContactName>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Fax>string</Fax>
          <Email>string</Email>
          <WebSite>string</WebSite>
          <CustomerUnit>string</CustomerUnit>
          <SalesAccount>string</SalesAccount>
          <PaymentAccount>string</PaymentAccount>
          <CashPaymentAccount>string</CashPaymentAccount>
          <AccountingMethod>string</AccountingMethod>
          <ExternalCustomerID>string</ExternalCustomerID>
        </TCustomers>
      </GetCustomersResult>
    </GetCustomersResponse>
  </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 /Web1243/services/DC_Catering.asmx HTTP/1.1
Host: rmhs.rmdatacentral.com
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>
    <AuthenticationHeader xmlns="http://restaurantmagic.com/services">
      <UserName>string</UserName>
      <Password>string</Password>
    </AuthenticationHeader>
    <AuthenticationKey xmlns="http://restaurantmagic.com/services">
      <IntegrationKey>string</IntegrationKey>
    </AuthenticationKey>
  </soap12:Header>
  <soap12:Body>
    <GetCustomers xmlns="http://restaurantmagic.com/services">
      <CustomerID>string</CustomerID>
      <ExternalCustomerID>string</ExternalCustomerID>
      <Description>string</Description>
      <Phone>string</Phone>
    </GetCustomers>
  </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>
    <GetCustomersResponse xmlns="http://restaurantmagic.com/services">
      <GetCustomersResult>
        <TCustomers>
          <CustomerID>string</CustomerID>
          <BillToCode>string</BillToCode>
          <Description>string</Description>
          <Type>string</Type>
          <Usage>string</Usage>
          <Hide>boolean</Hide>
          <Group1>string</Group1>
          <Group2>string</Group2>
          <Group3>string</Group3>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <ContactName>string</ContactName>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Fax>string</Fax>
          <Email>string</Email>
          <WebSite>string</WebSite>
          <CustomerUnit>string</CustomerUnit>
          <SalesAccount>string</SalesAccount>
          <PaymentAccount>string</PaymentAccount>
          <CashPaymentAccount>string</CashPaymentAccount>
          <AccountingMethod>string</AccountingMethod>
          <ExternalCustomerID>string</ExternalCustomerID>
        </TCustomers>
        <TCustomers>
          <CustomerID>string</CustomerID>
          <BillToCode>string</BillToCode>
          <Description>string</Description>
          <Type>string</Type>
          <Usage>string</Usage>
          <Hide>boolean</Hide>
          <Group1>string</Group1>
          <Group2>string</Group2>
          <Group3>string</Group3>
          <Address1>string</Address1>
          <Address2>string</Address2>
          <City>string</City>
          <State>string</State>
          <Zip>string</Zip>
          <Country>string</Country>
          <ContactName>string</ContactName>
          <Phone>string</Phone>
          <CellPhone>string</CellPhone>
          <Fax>string</Fax>
          <Email>string</Email>
          <WebSite>string</WebSite>
          <CustomerUnit>string</CustomerUnit>
          <SalesAccount>string</SalesAccount>
          <PaymentAccount>string</PaymentAccount>
          <CashPaymentAccount>string</CashPaymentAccount>
          <AccountingMethod>string</AccountingMethod>
          <ExternalCustomerID>string</ExternalCustomerID>
        </TCustomers>
      </GetCustomersResult>
    </GetCustomersResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Web1243/services/DC_Catering.asmx/GetCustomers?CustomerID=string&ExternalCustomerID=string&Description=string&Phone=string HTTP/1.1
Host: rmhs.rmdatacentral.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCustomers xmlns="http://restaurantmagic.com/services">
  <TCustomers>
    <CustomerID>string</CustomerID>
    <BillToCode>string</BillToCode>
    <Description>string</Description>
    <Type>string</Type>
    <Usage>string</Usage>
    <Hide>boolean</Hide>
    <Group1>string</Group1>
    <Group2>string</Group2>
    <Group3>string</Group3>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Country>string</Country>
    <ContactName>string</ContactName>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <Fax>string</Fax>
    <Email>string</Email>
    <WebSite>string</WebSite>
    <CustomerUnit>string</CustomerUnit>
    <SalesAccount>string</SalesAccount>
    <PaymentAccount>string</PaymentAccount>
    <CashPaymentAccount>string</CashPaymentAccount>
    <AccountingMethod>string</AccountingMethod>
    <ExternalCustomerID>string</ExternalCustomerID>
  </TCustomers>
  <TCustomers>
    <CustomerID>string</CustomerID>
    <BillToCode>string</BillToCode>
    <Description>string</Description>
    <Type>string</Type>
    <Usage>string</Usage>
    <Hide>boolean</Hide>
    <Group1>string</Group1>
    <Group2>string</Group2>
    <Group3>string</Group3>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Country>string</Country>
    <ContactName>string</ContactName>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <Fax>string</Fax>
    <Email>string</Email>
    <WebSite>string</WebSite>
    <CustomerUnit>string</CustomerUnit>
    <SalesAccount>string</SalesAccount>
    <PaymentAccount>string</PaymentAccount>
    <CashPaymentAccount>string</CashPaymentAccount>
    <AccountingMethod>string</AccountingMethod>
    <ExternalCustomerID>string</ExternalCustomerID>
  </TCustomers>
</ArrayOfTCustomers>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Web1243/services/DC_Catering.asmx/GetCustomers HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

CustomerID=string&ExternalCustomerID=string&Description=string&Phone=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCustomers xmlns="http://restaurantmagic.com/services">
  <TCustomers>
    <CustomerID>string</CustomerID>
    <BillToCode>string</BillToCode>
    <Description>string</Description>
    <Type>string</Type>
    <Usage>string</Usage>
    <Hide>boolean</Hide>
    <Group1>string</Group1>
    <Group2>string</Group2>
    <Group3>string</Group3>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Country>string</Country>
    <ContactName>string</ContactName>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <Fax>string</Fax>
    <Email>string</Email>
    <WebSite>string</WebSite>
    <CustomerUnit>string</CustomerUnit>
    <SalesAccount>string</SalesAccount>
    <PaymentAccount>string</PaymentAccount>
    <CashPaymentAccount>string</CashPaymentAccount>
    <AccountingMethod>string</AccountingMethod>
    <ExternalCustomerID>string</ExternalCustomerID>
  </TCustomers>
  <TCustomers>
    <CustomerID>string</CustomerID>
    <BillToCode>string</BillToCode>
    <Description>string</Description>
    <Type>string</Type>
    <Usage>string</Usage>
    <Hide>boolean</Hide>
    <Group1>string</Group1>
    <Group2>string</Group2>
    <Group3>string</Group3>
    <Address1>string</Address1>
    <Address2>string</Address2>
    <City>string</City>
    <State>string</State>
    <Zip>string</Zip>
    <Country>string</Country>
    <ContactName>string</ContactName>
    <Phone>string</Phone>
    <CellPhone>string</CellPhone>
    <Fax>string</Fax>
    <Email>string</Email>
    <WebSite>string</WebSite>
    <CustomerUnit>string</CustomerUnit>
    <SalesAccount>string</SalesAccount>
    <PaymentAccount>string</PaymentAccount>
    <CashPaymentAccount>string</CashPaymentAccount>
    <AccountingMethod>string</AccountingMethod>
    <ExternalCustomerID>string</ExternalCustomerID>
  </TCustomers>
</ArrayOfTCustomers>