Summary

This API provides the ability look up a Customer by the Customer id. The response will include basic Customer information and various links to look up additional Customer information such as Demographics, Addresses, etc for a single Customer record.

If the customer has been merged into another customer or deactivated an error message will be returned. (Please see failure section for more details)

General Technical Requirements

The following technical requirements apply to all requests for this API.

Base Resource URI

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/*

Testing:    https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/*

brandAbbreviation is the abbreviation for the brand customerId 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 always 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.

Supported HTTP Methods

There is one HTTP method supported:

GET : See W3C’s GET specs for details.

Lookup Customer By Customer Id

Retrieves a record containing all available name, contact, and demographic information about the customer.

Field Definition

The following table describes the data elements present on the response from the API.

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.

Customer Elements

OriginalPromoCodeNoStringOriginal “Promo Code” that was used to create this customer.

Element Name	Always Returned…	Data Type	Description

Element Name	Always Returned…	Data Type	Description
Id	Conditional	Integer	internal id (for use on certain databases)
ReaderId	Conditional	Integer	reader id (for use on certain databases) typically either the reader id or the id is returned, but not both.
EncryptedCustomerId	Yes	String	The Encrypted Customer Id for the customer
Salutation	No	String	“Mrs.”, “Mr.”, etc.
FirstName	No	String	first name
MiddleName	No	String	middle name
LastName	No	String	last name
Suffix	No	String	“Jr.”, “Sr.”, “III”, etc.
Title	No	String	job title
Gender	No	String	“F” for Female, “M” for Male, “U” for Unknown.
PromoCode	No	String	“Promo Code” last used to create/update this customer.
SignUpDate	No	DateTime	Date & time customer “signed up” as customer. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
ChangedDate	No	DateTime	Date & time record last changed. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
StatusCode	No	Short	1 for “Active”, 0 for “Deleted/Inactive”, 2 for “Prospect”.
MergeCode	Yes	Short	1 for “Mergeable”, 0 for “Non-Mergeable”
Addresses	Yes	Link	a link reference to the address data as a resource.
Phones	Yes	Link	a link reference to the phone data as a resource.
EmailAddresses	Yes	Link	a link reference to the email data as a resource.
CustomerDemographics	Yes	Link	a link reference to the customer demographic data as a resource.
Subscriptions	Yes	Link	a link reference to the subscription data as a resource.

Response

HTTP Response Codes

Status	Description

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.

Success

{
   "Id" : 12345,
   "Salutation" : "Mr.",
   "FirstName" : "John",
   "MiddleName" : "J",
   "LastName" : "Smith",
   "Suffix" : "Jr.",
   "Title" : "Developer",
   "Gender" : "M",
   "ClientCustomerId" : "543210",
   "OriginalPromoCode" : "2009_SIGNUP_SPECIAL",
   "PromoCode" : "2010_RENEWAL",
   "SignUpDate" : "2009-03-08 21:23:34",
   "ChangedDate" : "2010-03-08 14:07:12",
   "StatusCode" : 1,
   "MergeCode" : 1,
   "Addresses" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/address/*",  
   "Phones" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/phone/*",
   "EmailAddresses" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/email/*",
   "CustomerDemographics" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/demographic/*",
   "Subscriptions" : "https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/subscription/*"
   "SubmissionId" : "24B9BF6F-0677-462B-942A-D87EEBD10F77"
}

Failure

Standard Customer Error Message

{
   "SubmissionId":"ec0c2ba6-13f4-4934-8efa-74c2ccb33f1d",
   "Errors":[
      {
         "Error":"Customer 12345 was not found."
      }
   ]
}

Merged Customer Error Message

Possible Error Messages

In the event of an error, an error response will be returned. Here are some of the possible responses you might receive.

Table of Contents

1 Summary
2 General Technical Requirements
- 2.1 Base Resource URI
- 2.2 HTTP Headers
- 2.3 Content Type
- 2.4 Supported HTTP Methods
3 Lookup Customer By Customer Id
- 3.1 Field Definition
  - 3.1.1 Customer Elements
- 3.2 Response
  - 3.2.1 HTTP Response Codes
  - 3.2.2 Success
  - 3.2.3 Failure
    - 3.2.3.1 Standard Customer Error Message
    - 3.2.3.2 Merged Customer Error Message
    - 3.2.3.3 Possible Error Messages

Omeda Client Knowledge Base

Customer Lookup By Customer Id