DC_Catering


Click here for a complete list of operations.

GetCateringOrderHeaders

Get Catering Order Headers list available for the user.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
OrderHeaderID:
OrderNumber:
Unit:
FromDate:
ThroughDate:
Status:
ExternalOnly:
ExternalDocumentID:

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

<?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>
    <GetCateringOrderHeaders xmlns="http://restaurantmagic.com/services">
      <OrderHeaderID>string</OrderHeaderID>
      <OrderNumber>string</OrderNumber>
      <Unit>string</Unit>
      <FromDate>string</FromDate>
      <ThroughDate>string</ThroughDate>
      <Status>string</Status>
      <ExternalOnly>string</ExternalOnly>
      <ExternalDocumentID>string</ExternalDocumentID>
    </GetCateringOrderHeaders>
  </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>
    <GetCateringOrderHeadersResponse xmlns="http://restaurantmagic.com/services">
      <GetCateringOrderHeadersResult>
        <TCateringOrderHeader>
          <OrderHeaderID>string</OrderHeaderID>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <Status>string</Status>
          <MasterOrderNumber>string</MasterOrderNumber>
          <UnitID>int</UnitID>
          <UnitName>string</UnitName>
          <CustomerID>string</CustomerID>
          <CustomerDescription>string</CustomerDescription>
          <PrimaryCustomerContact>string</PrimaryCustomerContact>
          <Description>string</Description>
          <SetupTypeID>string</SetupTypeID>
          <SetupTypeDescription>string</SetupTypeDescription>
          <DietaryRestrictions>string</DietaryRestrictions>
          <EventDate>dateTime</EventDate>
          <Duration>decimal</Duration>
          <ChildGuarantee>int</ChildGuarantee>
          <AdultGuarantee>int</AdultGuarantee>
          <SoldBy>string</SoldBy>
          <Coordinator>string</Coordinator>
          <PaymentTermID>string</PaymentTermID>
          <PaymentTermDescription>string</PaymentTermDescription>
          <DiscountID>string</DiscountID>
          <DiscountDescription>string</DiscountDescription>
          <TaxID>string</TaxID>
          <TaxDescription>string</TaxDescription>
          <TaxExemptID>string</TaxExemptID>
          <QuotedDate>dateTime</QuotedDate>
          <ConfirmedDate>dateTime</ConfirmedDate>
          <CancelledDate>dateTime</CancelledDate>
          <FinalizedDate>dateTime</FinalizedDate>
          <Location>string</Location>
          <Details>string</Details>
          <Comment>string</Comment>
          <ExternalDocumentID>string</ExternalDocumentID>
          <ExternalCustomer>string</ExternalCustomer>
          <ExternalSetupType>string</ExternalSetupType>
          <ExternalTax>string</ExternalTax>
          <ExternalDiscount>string</ExternalDiscount>
          <ExternalPaymentTerm>string</ExternalPaymentTerm>
          <Imported>boolean</Imported>
        </TCateringOrderHeader>
        <TCateringOrderHeader>
          <OrderHeaderID>string</OrderHeaderID>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <Status>string</Status>
          <MasterOrderNumber>string</MasterOrderNumber>
          <UnitID>int</UnitID>
          <UnitName>string</UnitName>
          <CustomerID>string</CustomerID>
          <CustomerDescription>string</CustomerDescription>
          <PrimaryCustomerContact>string</PrimaryCustomerContact>
          <Description>string</Description>
          <SetupTypeID>string</SetupTypeID>
          <SetupTypeDescription>string</SetupTypeDescription>
          <DietaryRestrictions>string</DietaryRestrictions>
          <EventDate>dateTime</EventDate>
          <Duration>decimal</Duration>
          <ChildGuarantee>int</ChildGuarantee>
          <AdultGuarantee>int</AdultGuarantee>
          <SoldBy>string</SoldBy>
          <Coordinator>string</Coordinator>
          <PaymentTermID>string</PaymentTermID>
          <PaymentTermDescription>string</PaymentTermDescription>
          <DiscountID>string</DiscountID>
          <DiscountDescription>string</DiscountDescription>
          <TaxID>string</TaxID>
          <TaxDescription>string</TaxDescription>
          <TaxExemptID>string</TaxExemptID>
          <QuotedDate>dateTime</QuotedDate>
          <ConfirmedDate>dateTime</ConfirmedDate>
          <CancelledDate>dateTime</CancelledDate>
          <FinalizedDate>dateTime</FinalizedDate>
          <Location>string</Location>
          <Details>string</Details>
          <Comment>string</Comment>
          <ExternalDocumentID>string</ExternalDocumentID>
          <ExternalCustomer>string</ExternalCustomer>
          <ExternalSetupType>string</ExternalSetupType>
          <ExternalTax>string</ExternalTax>
          <ExternalDiscount>string</ExternalDiscount>
          <ExternalPaymentTerm>string</ExternalPaymentTerm>
          <Imported>boolean</Imported>
        </TCateringOrderHeader>
      </GetCateringOrderHeadersResult>
    </GetCateringOrderHeadersResponse>
  </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>
    <GetCateringOrderHeaders xmlns="http://restaurantmagic.com/services">
      <OrderHeaderID>string</OrderHeaderID>
      <OrderNumber>string</OrderNumber>
      <Unit>string</Unit>
      <FromDate>string</FromDate>
      <ThroughDate>string</ThroughDate>
      <Status>string</Status>
      <ExternalOnly>string</ExternalOnly>
      <ExternalDocumentID>string</ExternalDocumentID>
    </GetCateringOrderHeaders>
  </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>
    <GetCateringOrderHeadersResponse xmlns="http://restaurantmagic.com/services">
      <GetCateringOrderHeadersResult>
        <TCateringOrderHeader>
          <OrderHeaderID>string</OrderHeaderID>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <Status>string</Status>
          <MasterOrderNumber>string</MasterOrderNumber>
          <UnitID>int</UnitID>
          <UnitName>string</UnitName>
          <CustomerID>string</CustomerID>
          <CustomerDescription>string</CustomerDescription>
          <PrimaryCustomerContact>string</PrimaryCustomerContact>
          <Description>string</Description>
          <SetupTypeID>string</SetupTypeID>
          <SetupTypeDescription>string</SetupTypeDescription>
          <DietaryRestrictions>string</DietaryRestrictions>
          <EventDate>dateTime</EventDate>
          <Duration>decimal</Duration>
          <ChildGuarantee>int</ChildGuarantee>
          <AdultGuarantee>int</AdultGuarantee>
          <SoldBy>string</SoldBy>
          <Coordinator>string</Coordinator>
          <PaymentTermID>string</PaymentTermID>
          <PaymentTermDescription>string</PaymentTermDescription>
          <DiscountID>string</DiscountID>
          <DiscountDescription>string</DiscountDescription>
          <TaxID>string</TaxID>
          <TaxDescription>string</TaxDescription>
          <TaxExemptID>string</TaxExemptID>
          <QuotedDate>dateTime</QuotedDate>
          <ConfirmedDate>dateTime</ConfirmedDate>
          <CancelledDate>dateTime</CancelledDate>
          <FinalizedDate>dateTime</FinalizedDate>
          <Location>string</Location>
          <Details>string</Details>
          <Comment>string</Comment>
          <ExternalDocumentID>string</ExternalDocumentID>
          <ExternalCustomer>string</ExternalCustomer>
          <ExternalSetupType>string</ExternalSetupType>
          <ExternalTax>string</ExternalTax>
          <ExternalDiscount>string</ExternalDiscount>
          <ExternalPaymentTerm>string</ExternalPaymentTerm>
          <Imported>boolean</Imported>
        </TCateringOrderHeader>
        <TCateringOrderHeader>
          <OrderHeaderID>string</OrderHeaderID>
          <OrderDate>dateTime</OrderDate>
          <OrderNumber>string</OrderNumber>
          <Status>string</Status>
          <MasterOrderNumber>string</MasterOrderNumber>
          <UnitID>int</UnitID>
          <UnitName>string</UnitName>
          <CustomerID>string</CustomerID>
          <CustomerDescription>string</CustomerDescription>
          <PrimaryCustomerContact>string</PrimaryCustomerContact>
          <Description>string</Description>
          <SetupTypeID>string</SetupTypeID>
          <SetupTypeDescription>string</SetupTypeDescription>
          <DietaryRestrictions>string</DietaryRestrictions>
          <EventDate>dateTime</EventDate>
          <Duration>decimal</Duration>
          <ChildGuarantee>int</ChildGuarantee>
          <AdultGuarantee>int</AdultGuarantee>
          <SoldBy>string</SoldBy>
          <Coordinator>string</Coordinator>
          <PaymentTermID>string</PaymentTermID>
          <PaymentTermDescription>string</PaymentTermDescription>
          <DiscountID>string</DiscountID>
          <DiscountDescription>string</DiscountDescription>
          <TaxID>string</TaxID>
          <TaxDescription>string</TaxDescription>
          <TaxExemptID>string</TaxExemptID>
          <QuotedDate>dateTime</QuotedDate>
          <ConfirmedDate>dateTime</ConfirmedDate>
          <CancelledDate>dateTime</CancelledDate>
          <FinalizedDate>dateTime</FinalizedDate>
          <Location>string</Location>
          <Details>string</Details>
          <Comment>string</Comment>
          <ExternalDocumentID>string</ExternalDocumentID>
          <ExternalCustomer>string</ExternalCustomer>
          <ExternalSetupType>string</ExternalSetupType>
          <ExternalTax>string</ExternalTax>
          <ExternalDiscount>string</ExternalDiscount>
          <ExternalPaymentTerm>string</ExternalPaymentTerm>
          <Imported>boolean</Imported>
        </TCateringOrderHeader>
      </GetCateringOrderHeadersResult>
    </GetCateringOrderHeadersResponse>
  </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/GetCateringOrderHeaders?OrderHeaderID=string&OrderNumber=string&Unit=string&FromDate=string&ThroughDate=string&Status=string&ExternalOnly=string&ExternalDocumentID=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"?>
<ArrayOfTCateringOrderHeader xmlns="http://restaurantmagic.com/services">
  <TCateringOrderHeader>
    <OrderHeaderID>string</OrderHeaderID>
    <OrderDate>dateTime</OrderDate>
    <OrderNumber>string</OrderNumber>
    <Status>string</Status>
    <MasterOrderNumber>string</MasterOrderNumber>
    <UnitID>int</UnitID>
    <UnitName>string</UnitName>
    <CustomerID>string</CustomerID>
    <CustomerDescription>string</CustomerDescription>
    <PrimaryCustomerContact>string</PrimaryCustomerContact>
    <Description>string</Description>
    <SetupTypeID>string</SetupTypeID>
    <SetupTypeDescription>string</SetupTypeDescription>
    <DietaryRestrictions>string</DietaryRestrictions>
    <EventDate>dateTime</EventDate>
    <Duration>decimal</Duration>
    <ChildGuarantee>int</ChildGuarantee>
    <AdultGuarantee>int</AdultGuarantee>
    <SoldBy>string</SoldBy>
    <Coordinator>string</Coordinator>
    <PaymentTermID>string</PaymentTermID>
    <PaymentTermDescription>string</PaymentTermDescription>
    <DiscountID>string</DiscountID>
    <DiscountDescription>string</DiscountDescription>
    <TaxID>string</TaxID>
    <TaxDescription>string</TaxDescription>
    <TaxExemptID>string</TaxExemptID>
    <QuotedDate>dateTime</QuotedDate>
    <ConfirmedDate>dateTime</ConfirmedDate>
    <CancelledDate>dateTime</CancelledDate>
    <FinalizedDate>dateTime</FinalizedDate>
    <Location>string</Location>
    <Details>string</Details>
    <Comment>string</Comment>
    <ExternalDocumentID>string</ExternalDocumentID>
    <ExternalCustomer>string</ExternalCustomer>
    <ExternalSetupType>string</ExternalSetupType>
    <ExternalTax>string</ExternalTax>
    <ExternalDiscount>string</ExternalDiscount>
    <ExternalPaymentTerm>string</ExternalPaymentTerm>
    <Imported>boolean</Imported>
  </TCateringOrderHeader>
  <TCateringOrderHeader>
    <OrderHeaderID>string</OrderHeaderID>
    <OrderDate>dateTime</OrderDate>
    <OrderNumber>string</OrderNumber>
    <Status>string</Status>
    <MasterOrderNumber>string</MasterOrderNumber>
    <UnitID>int</UnitID>
    <UnitName>string</UnitName>
    <CustomerID>string</CustomerID>
    <CustomerDescription>string</CustomerDescription>
    <PrimaryCustomerContact>string</PrimaryCustomerContact>
    <Description>string</Description>
    <SetupTypeID>string</SetupTypeID>
    <SetupTypeDescription>string</SetupTypeDescription>
    <DietaryRestrictions>string</DietaryRestrictions>
    <EventDate>dateTime</EventDate>
    <Duration>decimal</Duration>
    <ChildGuarantee>int</ChildGuarantee>
    <AdultGuarantee>int</AdultGuarantee>
    <SoldBy>string</SoldBy>
    <Coordinator>string</Coordinator>
    <PaymentTermID>string</PaymentTermID>
    <PaymentTermDescription>string</PaymentTermDescription>
    <DiscountID>string</DiscountID>
    <DiscountDescription>string</DiscountDescription>
    <TaxID>string</TaxID>
    <TaxDescription>string</TaxDescription>
    <TaxExemptID>string</TaxExemptID>
    <QuotedDate>dateTime</QuotedDate>
    <ConfirmedDate>dateTime</ConfirmedDate>
    <CancelledDate>dateTime</CancelledDate>
    <FinalizedDate>dateTime</FinalizedDate>
    <Location>string</Location>
    <Details>string</Details>
    <Comment>string</Comment>
    <ExternalDocumentID>string</ExternalDocumentID>
    <ExternalCustomer>string</ExternalCustomer>
    <ExternalSetupType>string</ExternalSetupType>
    <ExternalTax>string</ExternalTax>
    <ExternalDiscount>string</ExternalDiscount>
    <ExternalPaymentTerm>string</ExternalPaymentTerm>
    <Imported>boolean</Imported>
  </TCateringOrderHeader>
</ArrayOfTCateringOrderHeader>

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/GetCateringOrderHeaders HTTP/1.1
Host: rmhs.rmdatacentral.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

OrderHeaderID=string&OrderNumber=string&Unit=string&FromDate=string&ThroughDate=string&Status=string&ExternalOnly=string&ExternalDocumentID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCateringOrderHeader xmlns="http://restaurantmagic.com/services">
  <TCateringOrderHeader>
    <OrderHeaderID>string</OrderHeaderID>
    <OrderDate>dateTime</OrderDate>
    <OrderNumber>string</OrderNumber>
    <Status>string</Status>
    <MasterOrderNumber>string</MasterOrderNumber>
    <UnitID>int</UnitID>
    <UnitName>string</UnitName>
    <CustomerID>string</CustomerID>
    <CustomerDescription>string</CustomerDescription>
    <PrimaryCustomerContact>string</PrimaryCustomerContact>
    <Description>string</Description>
    <SetupTypeID>string</SetupTypeID>
    <SetupTypeDescription>string</SetupTypeDescription>
    <DietaryRestrictions>string</DietaryRestrictions>
    <EventDate>dateTime</EventDate>
    <Duration>decimal</Duration>
    <ChildGuarantee>int</ChildGuarantee>
    <AdultGuarantee>int</AdultGuarantee>
    <SoldBy>string</SoldBy>
    <Coordinator>string</Coordinator>
    <PaymentTermID>string</PaymentTermID>
    <PaymentTermDescription>string</PaymentTermDescription>
    <DiscountID>string</DiscountID>
    <DiscountDescription>string</DiscountDescription>
    <TaxID>string</TaxID>
    <TaxDescription>string</TaxDescription>
    <TaxExemptID>string</TaxExemptID>
    <QuotedDate>dateTime</QuotedDate>
    <ConfirmedDate>dateTime</ConfirmedDate>
    <CancelledDate>dateTime</CancelledDate>
    <FinalizedDate>dateTime</FinalizedDate>
    <Location>string</Location>
    <Details>string</Details>
    <Comment>string</Comment>
    <ExternalDocumentID>string</ExternalDocumentID>
    <ExternalCustomer>string</ExternalCustomer>
    <ExternalSetupType>string</ExternalSetupType>
    <ExternalTax>string</ExternalTax>
    <ExternalDiscount>string</ExternalDiscount>
    <ExternalPaymentTerm>string</ExternalPaymentTerm>
    <Imported>boolean</Imported>
  </TCateringOrderHeader>
  <TCateringOrderHeader>
    <OrderHeaderID>string</OrderHeaderID>
    <OrderDate>dateTime</OrderDate>
    <OrderNumber>string</OrderNumber>
    <Status>string</Status>
    <MasterOrderNumber>string</MasterOrderNumber>
    <UnitID>int</UnitID>
    <UnitName>string</UnitName>
    <CustomerID>string</CustomerID>
    <CustomerDescription>string</CustomerDescription>
    <PrimaryCustomerContact>string</PrimaryCustomerContact>
    <Description>string</Description>
    <SetupTypeID>string</SetupTypeID>
    <SetupTypeDescription>string</SetupTypeDescription>
    <DietaryRestrictions>string</DietaryRestrictions>
    <EventDate>dateTime</EventDate>
    <Duration>decimal</Duration>
    <ChildGuarantee>int</ChildGuarantee>
    <AdultGuarantee>int</AdultGuarantee>
    <SoldBy>string</SoldBy>
    <Coordinator>string</Coordinator>
    <PaymentTermID>string</PaymentTermID>
    <PaymentTermDescription>string</PaymentTermDescription>
    <DiscountID>string</DiscountID>
    <DiscountDescription>string</DiscountDescription>
    <TaxID>string</TaxID>
    <TaxDescription>string</TaxDescription>
    <TaxExemptID>string</TaxExemptID>
    <QuotedDate>dateTime</QuotedDate>
    <ConfirmedDate>dateTime</ConfirmedDate>
    <CancelledDate>dateTime</CancelledDate>
    <FinalizedDate>dateTime</FinalizedDate>
    <Location>string</Location>
    <Details>string</Details>
    <Comment>string</Comment>
    <ExternalDocumentID>string</ExternalDocumentID>
    <ExternalCustomer>string</ExternalCustomer>
    <ExternalSetupType>string</ExternalSetupType>
    <ExternalTax>string</ExternalTax>
    <ExternalDiscount>string</ExternalDiscount>
    <ExternalPaymentTerm>string</ExternalPaymentTerm>
    <Imported>boolean</Imported>
  </TCateringOrderHeader>
</ArrayOfTCateringOrderHeader>