GetCustomers

Method

GetCustomers(GetCustomersRequest)

Search for customers.

Declaration

public GetCustomersResponse GetCustomers(GetCustomersRequest request)

Parameters

TYPE	NAME	DESCRIPTION
GetCustomersRequest	request	GetCustomersCriteriaAccountNumber GetCustomersCriteriaCustomerName GetCustomersCriteriaCustomerNumber

Returns

TYPE	DESCRIPTION
GetCustomersResponse

Example C#

private string GetCustomerReference()
{
    string customerReference = null;
    //Find a customer 3 different ways
    //It is not normal to always search all 3 ways
    //We suggest giving the user the option to choose how they search
    if (customerReference == null)
    {
        var customers = GetCustomers_AccountNumber("123");
        if (customers.Length > 0)
            customerReference = customers[0].CustomerReference;
    }

    if (customerReference == null)
    {
        var customers = GetCustomers_CustomerName("Joe Test");
        if (customers.Length > 0)
            customerReference = customers[0].CustomerReference;
    }

    if (customerReference == null)
    {
        var customers = GetCustomers_CustomerNumber("XYZ123");
        if (customers.Length > 0)
            customerReference = customers[0].CustomerReference;
    }
    return customerReference;
}
private Customer[] GetCustomers_AccountNumber(string accountNumber)
{
    using (RDCWebServiceClient client = new RDCWebServiceClient())
    {
        var request = new GetCustomersRequest()
        {
            Criteria = new GetCustomersCriteriaAccountNumber()
            {
                AccountNumber = accountNumber
            },

            Credentials = credentials,
            RequestDate = DateTime.Now,
            RequestId = NewRequestId()
        };

        var response = client.GetCustomers(request);
        if (CheckSuccess(response))
        {
            return response.Customers;
        }
        else
        {
            HandleOther(response);
            return new Customer[0];
        }
    }
}
private Customer[] GetCustomers_CustomerName(string customerName)
{
    using (RDCWebServiceClient client = new RDCWebServiceClient())
    {
        var request = new GetCustomersRequest()
        {
            Criteria = new GetCustomersCriteriaCustomerName()
            {
                CustomerName = customerName
            },

            Credentials = credentials,
            RequestDate = DateTime.Now,
            RequestId = NewRequestId()
        };

        var response = client.GetCustomers(request);
        if (CheckSuccess(response))
        {
            return response.Customers;
        }
        else
        {
            HandleOther(response);
            return new Customer[0];
        }
    }
}
private Customer[] GetCustomers_CustomerNumber(string customerNumber)
{
    using (RDCWebServiceClient client = new RDCWebServiceClient())
    {
        var request = new GetCustomersRequest()
        {
            Criteria = new GetCustomersCriteriaCustomerNumber()
            {
                CustomerNumber = customerNumber
            },

            Credentials = credentials,
            RequestDate = DateTime.Now,
            RequestId = NewRequestId()
        };

        var response = client.GetCustomers(request);
        if (CheckSuccess(response))
        {
            return response.Customers;
        }
        else
        {
            HandleOther(response);
            return new Customer[0];
        }
    }
}

Example JS

function GetCustomersByAccountNumber(accountNumber, success, error) {
  var request = new XMLHttpRequest();
  var data = new GetCustomersRequest();
  var criteria = new GetCustomersCriteriaAccountNumber();

  criteria.AccountNumber = accountNumber;

  data.Criteria = criteria;
  data.Credentials = token;

  request.setRequestHeader("Content-type", "application/json; charset=utf-8");
  request.open(
    "POST",
    "http://localhost/mobile/RDCWebService.svc/GetCustomers",
    true
  );
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      if (request.status !== 200) {
        return error(request.statusText);
      }

      var response = JSON.parse(request.responseText);

      switch (response.Result) {
        case Result.Error:
        case Result.ValidationError:
          return error(response);
        case Result.Success:
        default:
          return success(response.Customers);
      }
    }
  };

  request.send(data);
}

function GetCustomersByName(customerName, success, error) {
  var request = new XMLHttpRequest();
  var data = new GetCustomersRequest();
  var criteria = new GetCustomersCriteriaCustomerName();

  criteria.CustomerName = customerName;

  data.Criteria = criteria;
  data.Credentials = token;

  request.setRequestHeader("Content-type", "application/json; charset=utf-8");
  request.open(
    "POST",
    "http://localhost/mobile/RDCWebService.svc/GetCustomers",
    true
  );
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      if (request.status !== 200) {
        return error(request.statusText);
      }

      var response = JSON.parse(request.responseText);

      switch (response.Result) {
        case Result.Error:
        case Result.ValidationError:
          return error(response);
        case Result.Success:
        default:
          return success(response.Customers);
      }
    }
  };

  request.send(data);
}

function GetCustomersByCustomerNumber(customerNumber, success, error) {
  var request = new XMLHttpRequest();
  var data = new GetCustomersRequest();
  var criteria = new GetCustomersCriteriaCustomerNumber();

  criteria.CustomerNumber = customerNumber;

  data.Criteria = criteria;
  data.Credentials = token;

  request.setRequestHeader("Content-type", "application/json; charset=utf-8");
  request.open(
    "POST",
    "http://localhost/mobile/RDCWebService.svc/GetCustomers",
    true
  );
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      if (request.status !== 200) {
        return error(request.statusText);
      }

      var response = JSON.parse(request.responseText);

      switch (response.Result) {
        case Result.Error:
        case Result.ValidationError:
          return error(response);
        case Result.Success:
        default:
          return success(response.Customers);
      }
    }
  };

  request.send(data);
}