DC_Catering
Click here for a complete list of operations.
GetCateringItems
Get Catering 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/GetCateringItems"
<?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>
<GetCateringItems xmlns="http://restaurantmagic.com/services">
<SoldItemDescriptionContains>string</SoldItemDescriptionContains>
<CateringItemContains>string</CateringItemContains>
</GetCateringItems>
</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>
<GetCateringItemsResponse xmlns="http://restaurantmagic.com/services">
<GetCateringItemsResult>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
</GetCateringItemsResult>
</GetCateringItemsResponse>
</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>
<GetCateringItems xmlns="http://restaurantmagic.com/services">
<SoldItemDescriptionContains>string</SoldItemDescriptionContains>
<CateringItemContains>string</CateringItemContains>
</GetCateringItems>
</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>
<GetCateringItemsResponse xmlns="http://restaurantmagic.com/services">
<GetCateringItemsResult>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
</GetCateringItemsResult>
</GetCateringItemsResponse>
</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/GetCateringItems?SoldItemDescriptionContains=string&CateringItemContains=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"?>
<ArrayOfTCateringItem xmlns="http://restaurantmagic.com/services">
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
</ArrayOfTCateringItem>
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/GetCateringItems HTTP/1.1 Host: rmhs.rmdatacentral.com Content-Type: application/x-www-form-urlencoded Content-Length: length SoldItemDescriptionContains=string&CateringItemContains=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfTCateringItem xmlns="http://restaurantmagic.com/services">
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
<TCateringItem>
<CateringItemID>string</CateringItemID>
<Section>string</Section>
<SoldItemID>string</SoldItemID>
<SoldItemDescription>string</SoldItemDescription>
<UnitOfMeasureID>string</UnitOfMeasureID>
<UnitOfMeasureDescription>string</UnitOfMeasureDescription>
<CateringItem>string</CateringItem>
<RevenueAccountID>string</RevenueAccountID>
<RevenueAccountDescription>string</RevenueAccountDescription>
<Custom1>string</Custom1>
<Custom2>string</Custom2>
<Custom3>string</Custom3>
<PostToPmix>string</PostToPmix>
<AdultYield>decimal</AdultYield>
<ChildYield>decimal</ChildYield>
<DefaultPrice>decimal</DefaultPrice>
<Taxable>boolean</Taxable>
<Recommended>boolean</Recommended>
<Hide>boolean</Hide>
</TCateringItem>
</ArrayOfTCateringItem>