Get customer list by email address or organization name
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The API caller must have the VSR role to run the API.

Table 1. API details
Method
Resource address
Description
GET
resource/customer?_namedQuery=

			getCustomersByContactEmail

			&emailAddress=<email>
Get a customer list by the email address of the contact person.
GET
resource/customer?_namedQuery=

			getCustomersBySubscriberEmail

			&emailAddress=<email>
Get a customer list by the email address of the subscriber.
GET
resource/customer?_namedQuery=

			getCustomerByOrgName

			&orgName=<orgName>
Get a customer list by the organization name.
 


URL parameters


Provide the following parameters:

Table 2. Parameters

Parameter
Required
Description
email
Yes
The email address of the contact person or subscriber.
orgName
Yes
The name of the organization.
 


Output



Sample HTTP response

Examples

resource/customer?_namedQuery=getCustomersByContactEmail&emailAddress=shilpi@mailinator.com

resource/customer?_namedQuery=getCustomersBySubscriberEmail&emailAddress=shilpi@mailinator.com

resource/customer?_namedQuery=getCustomerByOrgName&orgName=ABC_Lab

For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Customer management services

Input
Method URI Description
GET /api/bss/resource/customer Get a customer list by the email address of the contact person.
The API caller must have the VSR role to run the API.
Name Type Optional Description
_namedQuery
enumerated No possible values are getCustomersBySubscriberEmail, getCustomersByContactEmail and getCustomerByOrgName
Authorized values:
  • getCustomersBySubscriberEmail
  • getCustomersByContactEmail
  • getCustomerByOrgName
emailAdress
string Yes emailAdress of the subscriber. This parameter is required if _namedQuery parameter value is getCustomersBySubscribersEmail or getCustomersByContactEmail
orgName
string Yes Organization Name. This parameter is required when _namedQuery parameter value is getCustomerByOrgName
Examples
resource/customer?_namedQuery=getCustomersByContactEmail&emailAddress=shilpi@mailinator.com

resource/customer?_namedQuery=getCustomersBySubscriberEmail&emailAddress=shilpi@mailinator.com

resource/customer?_namedQuery=getCustomerByOrgName&orgName=ABC_Lab