You are here: Customers and Contacts > getCustomerByCustomerRefId

Retrieve Customer by Customer Ref ID

Description

Retrieves customer details by using customer reference ID.

Please note that customerId and customerRefId are different.

Default Protocol Method Type URI
HTTPS GET getCustomerByCustomerRefId.xml

Query Parameters

Parameter Description Valid Values Optional
customerRefId The unique reference ID of the customer. String No

Sample Code

import java.io.IOException;
import java.net.URLDecoder;

//..............................
//..............................
//..............................
import org.apache.http.params.HttpParams;
public class EMSSample {
	private static DefaultHttpClient httpclient = new DefaultHttpClient();
	private static Principal principal = null;
	private static StringBuffer query;
	//..............................
	//..............................
	//..............................
	public static String getCustomerByCustomerRefId.xml()throws Exception  {
		if(!verifyLogin()){
			return "login failed";
		}
		HttpContext context = new BasicHttpContext();
		context.setAttribute(ClientContext.USER_TOKEN, principal);
		HttpGet get = new HttpGet("https://localhost:8443/ems/3.6/getCustomerByCustomerRefId.xml");
		query = new StringBuffer();
		setParameter("customerRefId", "123");
		get.setURI(new URI(URLDecoder.decode(get.getURI() + query.toString(),"UTF-8")));
		HttpResponse response = httpclient.execute(get, context);
		HttpEntity entity = response.getEntity();
		byte[] b = null;
		if (entity != null) {
			long l = entity.getContentLength();
			b = new byte[(int) l];
			entity.getContent().read(b);
			entity.consumeContent();
		}
		return new String(b);
	}
	static void setParameter(String key, String value) {
		if (query.toString().equals("")) {
			query.append("?" + key + "=" + value + "&");
		} else {
			query.append(key + "=" + value + "&");
		}
	}
}
   

Sample Response

<emsResponse>
  <customer>
    <contacts>
      <contact>
        <admin>false</admin>
        <contactEmail>retail@retail.com</contactEmail>
        <contactId>14</contactId>
        <contactName />
        <contactNumber />
        <creationTime>1335249857000</creationTime>
        <customerName>Retail</customerName>
        <modificationTime>1335249857000</modificationTime>
        <status>true</status>
      </contact>
    </contacts>
    <creationTime>1335249857000</creationTime>
    <customerId>15</customerId>
    <customerName>Retail</customerName>
    <customerRefId>Retail001</customerRefId>
    <desc />
    <enabled>true</enabled>
    <modificationTime>1335249857000</modificationTime>
    <refId />
    <timezone>(GMT) Coordinated Universal Time</timezone>
  </customer>
  <stat>ok</stat>
</emsResponse>
See Also:

Output Format for Failure

Error Codes

Error Code Description
100 Invalid request parameter.
101 You are not authorized to use this service.
107 An internal error occurred! Please report the error to System administrator.
122 {field} is a required field and should have a not null value. [Note: This error code is applicable for the fields - Eid, namespaceName, featureName, startDate, endDate, userIds, featureId, productName, productVersion, detailsLM, lmId, templateType, customAttribute, lineItemId, customerRefId, granularity, loginId, oldPassword, and newPassword.]
128 You should log on first.
512 The customer does not exist.
1081 Invalid Web service version provided