DC_Catering
Click here for a complete list of operations.
GetItems
Get 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/GetItems" <?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> <GetItems xmlns="http://restaurantmagic.com/services"> <ItemType>string</ItemType> <ItemDescriptionContains>string</ItemDescriptionContains> <PurchaseAccount>string</PurchaseAccount> <CustomContains>string</CustomContains> </GetItems> </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> <GetItemsResponse xmlns="http://restaurantmagic.com/services"> <GetItemsResult> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> </GetItemsResult> </GetItemsResponse> </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> <GetItems xmlns="http://restaurantmagic.com/services"> <ItemType>string</ItemType> <ItemDescriptionContains>string</ItemDescriptionContains> <PurchaseAccount>string</PurchaseAccount> <CustomContains>string</CustomContains> </GetItems> </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> <GetItemsResponse xmlns="http://restaurantmagic.com/services"> <GetItemsResult> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> </GetItemsResult> </GetItemsResponse> </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/GetItems?ItemType=string&ItemDescriptionContains=string&PurchaseAccount=string&CustomContains=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"?> <ArrayOfTItem xmlns="http://restaurantmagic.com/services"> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> </ArrayOfTItem>
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/GetItems HTTP/1.1 Host: rmhs.rmdatacentral.com Content-Type: application/x-www-form-urlencoded Content-Length: length ItemType=string&ItemDescriptionContains=string&PurchaseAccount=string&CustomContains=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfTItem xmlns="http://restaurantmagic.com/services"> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> <TItem> <ID>string</ID> <ItemDescription>string</ItemDescription> <ItemType>string</ItemType> <Lock>boolean</Lock> <Hide>boolean</Hide> <CostingMeasure>string</CostingMeasure> <StandardCost>decimal</StandardCost> <CostingMethod>string</CostingMethod> <Recommended>boolean</Recommended> <RequireCount>boolean</RequireCount> <EstimationMethod>string</EstimationMethod> <MeasureShelfLifeAndThawIn>string</MeasureShelfLifeAndThawIn> <DefaultReportingMeasure>string</DefaultReportingMeasure> <DefaultCountingMeasure>string</DefaultCountingMeasure> <DefaultPurchaseMeasure>string</DefaultPurchaseMeasure> <DefaultPrimaryVendor>string</DefaultPrimaryVendor> <DefaultAlternateVendor>string</DefaultAlternateVendor> <PurchaseAccount>string</PurchaseAccount> <DaysOnHand>int</DaysOnHand> <Custom1>string</Custom1> <Custom2>string</Custom2> <Custom3>string</Custom3> <ItemCode>string</ItemCode> </TItem> </ArrayOfTItem>