DC_Vendor
Click here for a complete list of operations.
GetLocalVendors
Get Local Vendors 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_Vendor.asmx HTTP/1.1 Host: rmhs.rmdatacentral.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://restaurantmagic.com/services/GetLocalVendors" <?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> <GetLocalVendors xmlns="http://restaurantmagic.com/services"> <VendorDescriptionContains>string</VendorDescriptionContains> <PayToDefaultContains>string</PayToDefaultContains> <ShowHiddenVendors>string</ShowHiddenVendors> <LinkShowMode>string</LinkShowMode> </GetLocalVendors> </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> <GetLocalVendorsResponse xmlns="http://restaurantmagic.com/services"> <GetLocalVendorsResult> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> </GetLocalVendorsResult> </GetLocalVendorsResponse> </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_Vendor.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> <GetLocalVendors xmlns="http://restaurantmagic.com/services"> <VendorDescriptionContains>string</VendorDescriptionContains> <PayToDefaultContains>string</PayToDefaultContains> <ShowHiddenVendors>string</ShowHiddenVendors> <LinkShowMode>string</LinkShowMode> </GetLocalVendors> </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> <GetLocalVendorsResponse xmlns="http://restaurantmagic.com/services"> <GetLocalVendorsResult> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> </GetLocalVendorsResult> </GetLocalVendorsResponse> </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_Vendor.asmx/GetLocalVendors?VendorDescriptionContains=string&PayToDefaultContains=string&ShowHiddenVendors=string&LinkShowMode=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"?> <ArrayOfTUVendor xmlns="http://restaurantmagic.com/services"> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> </ArrayOfTUVendor>
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_Vendor.asmx/GetLocalVendors HTTP/1.1 Host: rmhs.rmdatacentral.com Content-Type: application/x-www-form-urlencoded Content-Length: length VendorDescriptionContains=string&PayToDefaultContains=string&ShowHiddenVendors=string&LinkShowMode=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfTUVendor xmlns="http://restaurantmagic.com/services"> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> <TUVendor> <GlobalVendorID>string</GlobalVendorID> <LocalVendorID>string</LocalVendorID> <Unit>string</Unit> <Description>string</Description> <VendorSuppliedDivisionCode>string</VendorSuppliedDivisionCode> <VendorUnitID>string</VendorUnitID> <VendorBranchID>string</VendorBranchID> <Hide>boolean</Hide> <PurchasingType>string</PurchasingType> <CreateMode>string</CreateMode> <BranchPayTo>string</BranchPayTo> <PermissionRegularInvoice>boolean</PermissionRegularInvoice> <PermissionManualCheck>boolean</PermissionManualCheck> <PermissionPaidIn>boolean</PermissionPaidIn> <PermissionPaidOut>boolean</PermissionPaidOut> <PermissionCreditMemo>boolean</PermissionCreditMemo> <PermissionPurchaseOrder>boolean</PermissionPurchaseOrder> <EnableB2B>boolean</EnableB2B> <B2BIntegrationDefault>string</B2BIntegrationDefault> <POFileMask>string</POFileMask> <CRFileMask>string</CRFileMask> <EnablePOExport>boolean</EnablePOExport> <EnableCRExport>boolean</EnableCRExport> <PermissionAccounting>boolean</PermissionAccounting> <PermissionB2BOptions>boolean</PermissionB2BOptions> <PermissionContact>boolean</PermissionContact> <PermissionAddress>boolean</PermissionAddress> <ContactName>string</ContactName> <ContactWork>string</ContactWork> <ContactCell>string</ContactCell> <ContactFax>string</ContactFax> <ContactEmail>string</ContactEmail> <ContactWebSite>string</ContactWebSite> <Address1>string</Address1> <Address2>string</Address2> <AddressCity>string</AddressCity> <AddressState>string</AddressState> <AddressCountry>string</AddressCountry> <AddressZip>string</AddressZip> <AddedByUnit>boolean</AddedByUnit> <AccountingLinked>boolean</AccountingLinked> </TUVendor> </ArrayOfTUVendor>