PublicAPIService
Click here for a complete list of operations.
getCustomersByName
This function retrieves an array of the complete Customer Data for any Customer matching the CustomerName supplied.
Test
The test form is only available for requests from the local machine.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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: lbm-sharp.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getCustomersByName"
<?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>
<getCustomersByName xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
<Auth>
<User>string</User>
<Password>string</Password>
<CompanyID>string</CompanyID>
<Version>string</Version>
<PartnerToken>string</PartnerToken>
</Auth>
<CustomerName>string</CustomerName>
</getCustomersByName>
</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>
<getCustomersByNameResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
<getCustomersByNameResult>
<CustomerData>
<CustomerNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerNumber>
<CustomerName>
<Value>string</Value>
<Valid>boolean</Valid>
</CustomerName>
<Attn>
<Value>string</Value>
<Valid>boolean</Valid>
</Attn>
<Address>
<Value>string</Value>
<Valid>boolean</Valid>
</Address>
<City>
<Value>string</Value>
<Valid>boolean</Valid>
</City>
<State>
<Value>string</Value>
<Valid>boolean</Valid>
</State>
<Zip>
<Value>string</Value>
<Valid>boolean</Valid>
</Zip>
<Country>
<Value>string</Value>
<Valid>boolean</Valid>
</Country>
<Phone1>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone1>
<Phone2>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone2>
<Fax>
<Value>string</Value>
<Valid>boolean</Valid>
</Fax>
<Email>
<Value>string</Value>
<Valid>boolean</Valid>
</Email>
<WebSite>
<Value>string</Value>
<Valid>boolean</Valid>
</WebSite>
<Active>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Active>
<Prospect>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Prospect>
<AllowAutoMeterRequests>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoMeterRequests>
<AllowAutoOnHoldUpdates>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoOnHoldUpdates>
<ShipTo>
<Value>boolean</Value>
<Valid>boolean</Valid>
</ShipTo>
<Remarks>
<Value>string</Value>
<Valid>boolean</Valid>
</Remarks>
<RequirePONum>
<Value>boolean</Value>
<Valid>boolean</Valid>
</RequirePONum>
<OnHold>
<Value>boolean</Value>
<Valid>boolean</Valid>
</OnHold>
<ParentLocationNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ParentLocationNumber>
<MailToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MailToNumber>
<BillToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BillToNumber>
<CustomerTypeCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerTypeCode>
<SalesRep>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</SalesRep>
<ShipMethodCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ShipMethodCode>
<InvoiceMethod>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</InvoiceMethod>
<TermCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TermCode>
<TerritoryCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TerritoryCode>
<TaxCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TaxCode>
<Taxable>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Taxable>
<TaxCodeDescription>
<Value>string</Value>
<Valid>boolean</Valid>
</TaxCodeDescription>
<TaxRate>
<Value>decimal</Value>
<Valid>boolean</Valid>
</TaxRate>
<ARContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ARContact>
<DecisionContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</DecisionContact>
<EquipmentContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</EquipmentContact>
<MeterContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MeterContact>
<UseBillToAddress>
<Value>boolean</Value>
<Valid>boolean</Valid>
</UseBillToAddress>
<BillToAttn>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAttn>
<BillToAddress>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAddress>
<BillToCity>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCity>
<BillToCounty>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCounty>
<BillToState>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToState>
<BillToZip>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToZip>
<BillToCountry>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCountry>
<OnHoldCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</OnHoldCode>
<BranchNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BranchNumber>
<County>
<Value>string</Value>
<Valid>boolean</Valid>
</County>
<CustomProperties>
<CustomProperty xsi:nil="true" />
<CustomProperty xsi:nil="true" />
</CustomProperties>
</CustomerData>
<CustomerData>
<CustomerNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerNumber>
<CustomerName>
<Value>string</Value>
<Valid>boolean</Valid>
</CustomerName>
<Attn>
<Value>string</Value>
<Valid>boolean</Valid>
</Attn>
<Address>
<Value>string</Value>
<Valid>boolean</Valid>
</Address>
<City>
<Value>string</Value>
<Valid>boolean</Valid>
</City>
<State>
<Value>string</Value>
<Valid>boolean</Valid>
</State>
<Zip>
<Value>string</Value>
<Valid>boolean</Valid>
</Zip>
<Country>
<Value>string</Value>
<Valid>boolean</Valid>
</Country>
<Phone1>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone1>
<Phone2>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone2>
<Fax>
<Value>string</Value>
<Valid>boolean</Valid>
</Fax>
<Email>
<Value>string</Value>
<Valid>boolean</Valid>
</Email>
<WebSite>
<Value>string</Value>
<Valid>boolean</Valid>
</WebSite>
<Active>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Active>
<Prospect>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Prospect>
<AllowAutoMeterRequests>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoMeterRequests>
<AllowAutoOnHoldUpdates>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoOnHoldUpdates>
<ShipTo>
<Value>boolean</Value>
<Valid>boolean</Valid>
</ShipTo>
<Remarks>
<Value>string</Value>
<Valid>boolean</Valid>
</Remarks>
<RequirePONum>
<Value>boolean</Value>
<Valid>boolean</Valid>
</RequirePONum>
<OnHold>
<Value>boolean</Value>
<Valid>boolean</Valid>
</OnHold>
<ParentLocationNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ParentLocationNumber>
<MailToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MailToNumber>
<BillToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BillToNumber>
<CustomerTypeCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerTypeCode>
<SalesRep>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</SalesRep>
<ShipMethodCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ShipMethodCode>
<InvoiceMethod>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</InvoiceMethod>
<TermCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TermCode>
<TerritoryCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TerritoryCode>
<TaxCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TaxCode>
<Taxable>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Taxable>
<TaxCodeDescription>
<Value>string</Value>
<Valid>boolean</Valid>
</TaxCodeDescription>
<TaxRate>
<Value>decimal</Value>
<Valid>boolean</Valid>
</TaxRate>
<ARContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ARContact>
<DecisionContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</DecisionContact>
<EquipmentContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</EquipmentContact>
<MeterContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MeterContact>
<UseBillToAddress>
<Value>boolean</Value>
<Valid>boolean</Valid>
</UseBillToAddress>
<BillToAttn>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAttn>
<BillToAddress>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAddress>
<BillToCity>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCity>
<BillToCounty>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCounty>
<BillToState>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToState>
<BillToZip>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToZip>
<BillToCountry>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCountry>
<OnHoldCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</OnHoldCode>
<BranchNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BranchNumber>
<County>
<Value>string</Value>
<Valid>boolean</Valid>
</County>
<CustomProperties>
<CustomProperty xsi:nil="true" />
<CustomProperty xsi:nil="true" />
</CustomProperties>
</CustomerData>
</getCustomersByNameResult>
</getCustomersByNameResponse>
</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 /PIP/PublicAPIService.asmx HTTP/1.1
Host: lbm-sharp.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:Body>
<getCustomersByName xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
<Auth>
<User>string</User>
<Password>string</Password>
<CompanyID>string</CompanyID>
<Version>string</Version>
<PartnerToken>string</PartnerToken>
</Auth>
<CustomerName>string</CustomerName>
</getCustomersByName>
</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>
<getCustomersByNameResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
<getCustomersByNameResult>
<CustomerData>
<CustomerNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerNumber>
<CustomerName>
<Value>string</Value>
<Valid>boolean</Valid>
</CustomerName>
<Attn>
<Value>string</Value>
<Valid>boolean</Valid>
</Attn>
<Address>
<Value>string</Value>
<Valid>boolean</Valid>
</Address>
<City>
<Value>string</Value>
<Valid>boolean</Valid>
</City>
<State>
<Value>string</Value>
<Valid>boolean</Valid>
</State>
<Zip>
<Value>string</Value>
<Valid>boolean</Valid>
</Zip>
<Country>
<Value>string</Value>
<Valid>boolean</Valid>
</Country>
<Phone1>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone1>
<Phone2>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone2>
<Fax>
<Value>string</Value>
<Valid>boolean</Valid>
</Fax>
<Email>
<Value>string</Value>
<Valid>boolean</Valid>
</Email>
<WebSite>
<Value>string</Value>
<Valid>boolean</Valid>
</WebSite>
<Active>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Active>
<Prospect>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Prospect>
<AllowAutoMeterRequests>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoMeterRequests>
<AllowAutoOnHoldUpdates>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoOnHoldUpdates>
<ShipTo>
<Value>boolean</Value>
<Valid>boolean</Valid>
</ShipTo>
<Remarks>
<Value>string</Value>
<Valid>boolean</Valid>
</Remarks>
<RequirePONum>
<Value>boolean</Value>
<Valid>boolean</Valid>
</RequirePONum>
<OnHold>
<Value>boolean</Value>
<Valid>boolean</Valid>
</OnHold>
<ParentLocationNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ParentLocationNumber>
<MailToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MailToNumber>
<BillToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BillToNumber>
<CustomerTypeCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerTypeCode>
<SalesRep>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</SalesRep>
<ShipMethodCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ShipMethodCode>
<InvoiceMethod>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</InvoiceMethod>
<TermCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TermCode>
<TerritoryCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TerritoryCode>
<TaxCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TaxCode>
<Taxable>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Taxable>
<TaxCodeDescription>
<Value>string</Value>
<Valid>boolean</Valid>
</TaxCodeDescription>
<TaxRate>
<Value>decimal</Value>
<Valid>boolean</Valid>
</TaxRate>
<ARContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ARContact>
<DecisionContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</DecisionContact>
<EquipmentContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</EquipmentContact>
<MeterContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MeterContact>
<UseBillToAddress>
<Value>boolean</Value>
<Valid>boolean</Valid>
</UseBillToAddress>
<BillToAttn>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAttn>
<BillToAddress>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAddress>
<BillToCity>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCity>
<BillToCounty>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCounty>
<BillToState>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToState>
<BillToZip>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToZip>
<BillToCountry>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCountry>
<OnHoldCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</OnHoldCode>
<BranchNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BranchNumber>
<County>
<Value>string</Value>
<Valid>boolean</Valid>
</County>
<CustomProperties>
<CustomProperty xsi:nil="true" />
<CustomProperty xsi:nil="true" />
</CustomProperties>
</CustomerData>
<CustomerData>
<CustomerNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerNumber>
<CustomerName>
<Value>string</Value>
<Valid>boolean</Valid>
</CustomerName>
<Attn>
<Value>string</Value>
<Valid>boolean</Valid>
</Attn>
<Address>
<Value>string</Value>
<Valid>boolean</Valid>
</Address>
<City>
<Value>string</Value>
<Valid>boolean</Valid>
</City>
<State>
<Value>string</Value>
<Valid>boolean</Valid>
</State>
<Zip>
<Value>string</Value>
<Valid>boolean</Valid>
</Zip>
<Country>
<Value>string</Value>
<Valid>boolean</Valid>
</Country>
<Phone1>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone1>
<Phone2>
<Value>string</Value>
<Valid>boolean</Valid>
</Phone2>
<Fax>
<Value>string</Value>
<Valid>boolean</Valid>
</Fax>
<Email>
<Value>string</Value>
<Valid>boolean</Valid>
</Email>
<WebSite>
<Value>string</Value>
<Valid>boolean</Valid>
</WebSite>
<Active>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Active>
<Prospect>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Prospect>
<AllowAutoMeterRequests>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoMeterRequests>
<AllowAutoOnHoldUpdates>
<Value>boolean</Value>
<Valid>boolean</Valid>
</AllowAutoOnHoldUpdates>
<ShipTo>
<Value>boolean</Value>
<Valid>boolean</Valid>
</ShipTo>
<Remarks>
<Value>string</Value>
<Valid>boolean</Valid>
</Remarks>
<RequirePONum>
<Value>boolean</Value>
<Valid>boolean</Valid>
</RequirePONum>
<OnHold>
<Value>boolean</Value>
<Valid>boolean</Valid>
</OnHold>
<ParentLocationNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ParentLocationNumber>
<MailToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MailToNumber>
<BillToNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BillToNumber>
<CustomerTypeCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</CustomerTypeCode>
<SalesRep>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</SalesRep>
<ShipMethodCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ShipMethodCode>
<InvoiceMethod>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</InvoiceMethod>
<TermCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TermCode>
<TerritoryCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TerritoryCode>
<TaxCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</TaxCode>
<Taxable>
<Value>boolean</Value>
<Valid>boolean</Valid>
</Taxable>
<TaxCodeDescription>
<Value>string</Value>
<Valid>boolean</Valid>
</TaxCodeDescription>
<TaxRate>
<Value>decimal</Value>
<Valid>boolean</Valid>
</TaxRate>
<ARContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</ARContact>
<DecisionContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</DecisionContact>
<EquipmentContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</EquipmentContact>
<MeterContact>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</MeterContact>
<UseBillToAddress>
<Value>boolean</Value>
<Valid>boolean</Valid>
</UseBillToAddress>
<BillToAttn>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAttn>
<BillToAddress>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToAddress>
<BillToCity>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCity>
<BillToCounty>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCounty>
<BillToState>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToState>
<BillToZip>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToZip>
<BillToCountry>
<Value>string</Value>
<Valid>boolean</Valid>
</BillToCountry>
<OnHoldCode>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</OnHoldCode>
<BranchNumber>
<ID xsi:nil="true" />
<Code xsi:nil="true" />
</BranchNumber>
<County>
<Value>string</Value>
<Valid>boolean</Valid>
</County>
<CustomProperties>
<CustomProperty xsi:nil="true" />
<CustomProperty xsi:nil="true" />
</CustomProperties>
</CustomerData>
</getCustomersByNameResult>
</getCustomersByNameResponse>
</soap12:Body>
</soap12:Envelope>