This API provides the ability look up a Customer’s Email Addresses by the Customer Id. This service returns all active email address information stored for the given customer.
General Technical Requirements
The following technical requirements apply to all requests for this API.
is the internal customer id (encrypted customer id may also be used)
HTTP Headers
The HTTP header must contain the following element:
x-omeda-appid
a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
Content Type
The content type is application/json.
JSON
application/json
JSON is the preferred data exchange format, because it is lightweight and, in most cases, faster to process and utilizes less bandwidth. There are many available open-source JSON libraries available. See json.org for details.
Retrieves a record containing all available active email information about a customer.
Field Definition
The following tables describe the hierarchical data elements.
In addition to the below elements, a SubmissionId element will also be returned with all responses. This is a unique identifier for the web services response. It can be used to cross-reference the response in Omeda’s database.
Emails Elements
Element Name
Description
Customer
Element containing an http reference to the owning customer resource.
Emails
each Email element contains all email information.
Date & time record last changed. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
StatusCode
No
Byte
Status of email address: 1 is the primary email address, 2 is an active email address.
HashedEmailAddress
No
String
The hashed value of the email address.
Response
HTTP Response Codes
Status
Description
200 OK
The request has succeeded. See Example Response below.
403 Forbidden
Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid.
404 Not Found
Typically, this error occurs with a malformed URL or the resource that is searched for is not found.
500 Internal Server Error
In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact your Omeda Account Representative if the issue continues.