DC_Catering Web Service

DC_Catering

Click here for a complete list of operations.

GetCateringOrderItems

Get Catering Order Items list available for the user.

Test

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

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

<?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>
    <GetCateringOrderItems xmlns="http://restaurantmagic.com/services">
      <OrderItemID>string</OrderItemID>
      <OrderHeaderID>string</OrderHeaderID>
      <ExternalDocumentID>string</ExternalDocumentID>
    </GetCateringOrderItems>
  </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>
    <GetCateringOrderItemsResponse xmlns="http://restaurantmagic.com/services">
      <GetCateringOrderItemsResult>
        <TCateringOrderItem>
          <OrderItemID>string</OrderItemID>
          <OrderHeaderID>string</OrderHeaderID>
          <LineNumber>int</LineNumber>
          <ItemID>string</ItemID>
          <ItemDescription>string</ItemDescription>
          <UnitOfMeasureID>string</UnitOfMeasureID>
          <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
          <Quantity>decimal</Quantity>
          <Price>decimal</Price>
          <PriceExtended>decimal</PriceExtended>
          <Taxable>boolean</Taxable>
          <Tax>decimal</Tax>
          <Discount>decimal</Discount>
          <SyncQuantity>boolean</SyncQuantity>
          <CateringItemID>string</CateringItemID>
          <CateringItem>string</CateringItem>
          <Comment>string</Comment>
        </TCateringOrderItem>
        <TCateringOrderItem>
          <OrderItemID>string</OrderItemID>
          <OrderHeaderID>string</OrderHeaderID>
          <LineNumber>int</LineNumber>
          <ItemID>string</ItemID>
          <ItemDescription>string</ItemDescription>
          <UnitOfMeasureID>string</UnitOfMeasureID>
          <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
          <Quantity>decimal</Quantity>
          <Price>decimal</Price>
          <PriceExtended>decimal</PriceExtended>
          <Taxable>boolean</Taxable>
          <Tax>decimal</Tax>
          <Discount>decimal</Discount>
          <SyncQuantity>boolean</SyncQuantity>
          <CateringItemID>string</CateringItemID>
          <CateringItem>string</CateringItem>
          <Comment>string</Comment>
        </TCateringOrderItem>
      </GetCateringOrderItemsResult>
    </GetCateringOrderItemsResponse>
  </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>
    <GetCateringOrderItems xmlns="http://restaurantmagic.com/services">
      <OrderItemID>string</OrderItemID>
      <OrderHeaderID>string</OrderHeaderID>
      <ExternalDocumentID>string</ExternalDocumentID>
    </GetCateringOrderItems>
  </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>
    <GetCateringOrderItemsResponse xmlns="http://restaurantmagic.com/services">
      <GetCateringOrderItemsResult>
        <TCateringOrderItem>
          <OrderItemID>string</OrderItemID>
          <OrderHeaderID>string</OrderHeaderID>
          <LineNumber>int</LineNumber>
          <ItemID>string</ItemID>
          <ItemDescription>string</ItemDescription>
          <UnitOfMeasureID>string</UnitOfMeasureID>
          <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
          <Quantity>decimal</Quantity>
          <Price>decimal</Price>
          <PriceExtended>decimal</PriceExtended>
          <Taxable>boolean</Taxable>
          <Tax>decimal</Tax>
          <Discount>decimal</Discount>
          <SyncQuantity>boolean</SyncQuantity>
          <CateringItemID>string</CateringItemID>
          <CateringItem>string</CateringItem>
          <Comment>string</Comment>
        </TCateringOrderItem>
        <TCateringOrderItem>
          <OrderItemID>string</OrderItemID>
          <OrderHeaderID>string</OrderHeaderID>
          <LineNumber>int</LineNumber>
          <ItemID>string</ItemID>
          <ItemDescription>string</ItemDescription>
          <UnitOfMeasureID>string</UnitOfMeasureID>
          <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
          <Quantity>decimal</Quantity>
          <Price>decimal</Price>
          <PriceExtended>decimal</PriceExtended>
          <Taxable>boolean</Taxable>
          <Tax>decimal</Tax>
          <Discount>decimal</Discount>
          <SyncQuantity>boolean</SyncQuantity>
          <CateringItemID>string</CateringItemID>
          <CateringItem>string</CateringItem>
          <Comment>string</Comment>
        </TCateringOrderItem>
      </GetCateringOrderItemsResult>
    </GetCateringOrderItemsResponse>
  </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/GetCateringOrderItems?OrderItemID=string&OrderHeaderID=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"?>
<ArrayOfTCateringOrderItem xmlns="http://restaurantmagic.com/services">
  <TCateringOrderItem>
    <OrderItemID>string</OrderItemID>
    <OrderHeaderID>string</OrderHeaderID>
    <LineNumber>int</LineNumber>
    <ItemID>string</ItemID>
    <ItemDescription>string</ItemDescription>
    <UnitOfMeasureID>string</UnitOfMeasureID>
    <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
    <Quantity>decimal</Quantity>
    <Price>decimal</Price>
    <PriceExtended>decimal</PriceExtended>
    <Taxable>boolean</Taxable>
    <Tax>decimal</Tax>
    <Discount>decimal</Discount>
    <SyncQuantity>boolean</SyncQuantity>
    <CateringItemID>string</CateringItemID>
    <CateringItem>string</CateringItem>
    <Comment>string</Comment>
  </TCateringOrderItem>
  <TCateringOrderItem>
    <OrderItemID>string</OrderItemID>
    <OrderHeaderID>string</OrderHeaderID>
    <LineNumber>int</LineNumber>
    <ItemID>string</ItemID>
    <ItemDescription>string</ItemDescription>
    <UnitOfMeasureID>string</UnitOfMeasureID>
    <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
    <Quantity>decimal</Quantity>
    <Price>decimal</Price>
    <PriceExtended>decimal</PriceExtended>
    <Taxable>boolean</Taxable>
    <Tax>decimal</Tax>
    <Discount>decimal</Discount>
    <SyncQuantity>boolean</SyncQuantity>
    <CateringItemID>string</CateringItemID>
    <CateringItem>string</CateringItem>
    <Comment>string</Comment>
  </TCateringOrderItem>
</ArrayOfTCateringOrderItem>

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

OrderItemID=string&OrderHeaderID=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"?>
<ArrayOfTCateringOrderItem xmlns="http://restaurantmagic.com/services">
  <TCateringOrderItem>
    <OrderItemID>string</OrderItemID>
    <OrderHeaderID>string</OrderHeaderID>
    <LineNumber>int</LineNumber>
    <ItemID>string</ItemID>
    <ItemDescription>string</ItemDescription>
    <UnitOfMeasureID>string</UnitOfMeasureID>
    <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
    <Quantity>decimal</Quantity>
    <Price>decimal</Price>
    <PriceExtended>decimal</PriceExtended>
    <Taxable>boolean</Taxable>
    <Tax>decimal</Tax>
    <Discount>decimal</Discount>
    <SyncQuantity>boolean</SyncQuantity>
    <CateringItemID>string</CateringItemID>
    <CateringItem>string</CateringItem>
    <Comment>string</Comment>
  </TCateringOrderItem>
  <TCateringOrderItem>
    <OrderItemID>string</OrderItemID>
    <OrderHeaderID>string</OrderHeaderID>
    <LineNumber>int</LineNumber>
    <ItemID>string</ItemID>
    <ItemDescription>string</ItemDescription>
    <UnitOfMeasureID>string</UnitOfMeasureID>
    <UnitOfMeasureDescription>string</UnitOfMeasureDescription>
    <Quantity>decimal</Quantity>
    <Price>decimal</Price>
    <PriceExtended>decimal</PriceExtended>
    <Taxable>boolean</Taxable>
    <Tax>decimal</Tax>
    <Discount>decimal</Discount>
    <SyncQuantity>boolean</SyncQuantity>
    <CateringItemID>string</CateringItemID>
    <CateringItem>string</CateringItem>
    <Comment>string</Comment>
  </TCateringOrderItem>
</ArrayOfTCateringOrderItem>

Parameter	Value
OrderItemID:
OrderHeaderID:
ExternalDocumentID: