Search the Omeda Knowledge Base
External ID Lookup By Customer Id
- Knowledge Base Home
- Documentation
- API & Webservices
- Customer Lookup APIs
- External ID Lookup By Customer Id
Summary
This API provides the ability look up a Customer’s External Ids by the Customer Id.
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}/externalid/* Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/customer/{customerId}/externalid/*
- 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 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 External Ids By Customer Id
Retrieves all available External IDs stored for a given customer id.
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.
External Ids Elements
Element Name | Description |
---|---|
Customer | Element containing an HTTP reference to the owning customer resource. |
ExternalIds | Each ExternalId element contains Id and Namespace information for each external ID that is stored. |
External Id Elements
Element Name | Always Returned… | Data Type | Description |
---|---|---|---|
Id | Yes | Long | The external identifier |
Namespace | Yes | String | This is the acronym used to differentiate the different kinds of external ids. For example, RDRNUM for the Omeda Legacy Id. |
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. |
Success
{ "Customer":"https://ows.omedastaging.com/webservices/rest/brand/FOO/customer/12345/*", "ExternalIds":[ { "Id":"478928", "Namespace":"SALESFORCE" }, { "Id":"GH1GG4D56J211", "Namespace":"LINKEDIN" } ] "SubmissionId" : "24B9BF6F-0677-462B-942A-D87EEBD10F77" }
Failure
{ "SubmissionId":"89ac9b95-cdd6-4152-b42b-14658a2be743", "Errors":[ { "Error":"No External Id found for customer 12345." } ] }
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.
No External Id found for customer {customerId}. Error looking up customer by customer id {customerId} for brand {brandId}.
-
-
-
- Behavior Lookup By Customer Id
- Customer Change Lookup
- Customer Comprehensive Lookup By Customer Id
- Customer Lookup By Customer Id
- Customer Lookup By Email Address
- Customer Lookup By EncryptedCustomerId
- Customer Lookup By External ID
- Customer Lookup By Name and Country
- Customer Lookup By PostalAddressId
- Customer Merge History Lookup
- Demographic Lookup By Customer Id
- Email Address Lookup By Customer Id
- External ID Lookup By Customer Id
- Phone Lookup By Customer Id
- Postal Address Lookup By Customer Id
- Subscription Lookup By Customer Id
- Subscription Lookup By Email
- Show all articles ( 2 ) Collapse Articles
-
- Email Audience Assignment Status
- Email Clicks
- Email Deployment
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Content Lookup
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Flag Email As Invalid
- Show all articles ( 6 ) Collapse Articles
-
-
- Release Notes for V18.10
- Release Notes for V18.11
- Release Notes for V18.12
- Release Notes for V18.13
- Release Notes for V18.14
- Release Notes for V18.15
- Release Notes for V18.16
- Release Notes for V18.9
- Release Notes for V19.1
- Release Notes for V19.10
- Release Notes for V19.11
- Release Notes for V19.12
- Release Notes for V19.13
- Release Notes for V19.14
- Release Notes for V19.15
- Release Notes for V19.16
- Release Notes for V19.2
- Release Notes for V19.3
- Release Notes for V19.4
- Release Notes for V19.5
- Release Notes for V19.6
- Release Notes for V19.7
- Release Notes for V19.8
- Release Notes for V19.9
- Show all articles ( 9 ) Collapse Articles
-
-
-
-
-
-
-
-
- Email Audience Assignment Status
- Email Clicks
- Email Deployment
- Email Deployment Add Audience
- Email Deployment Approval Lookup
- Email Deployment Audience List FTP
- Email Deployment Cancel
- Email Deployment Clone
- Email Deployment Content
- Email Deployment Lookup
- Email Deployment Remove Audience
- Email Deployment Schedule
- Email Deployment Search
- Email Deployment Test
- Email Deployment Unschedule
- Email On Demand Send
- Email Opt In/Out Lookup
- Email Optin Queue
- Email Optout Queue
- Flag Email As Invalid
- Show all articles ( 5 ) Collapse Articles
- Audience Builder (OnQ) - Query Result Outputs
- Email - A/B Testing
- Email - Advanced Features
- Email - Appending Lists On Triggered Deployments
- Email - Assigning Link Tracking Categories
- Email - Automated ACS Notifications
- Email - Deliverability
- Email - Deployment Checklist
- Email - Dynamic Content
- Email - FAQs
- Email - Getting Customer Support
- Email - Glossary
- Email - Link Tracking Errors
- Email - Merge Variables
- Email - Preference Page
- Email - Recurring Deployments
- Email - Triggered Deployments
- Email - User Guide
- Email - User Set-up
- Email - Web Tracking
- Email - Web Tracking String Parameter Definitions
- Email Builder - Getting Started
- Email Builder - Stealth Link
- Email Clickbot Reporting
- Email Validation Services
- Reports - Email Reporting
- Show all articles ( 11 ) Collapse Articles
-
-
-
-
- Audience Builder (OnQ) - Admin User Guide
- Audience Builder (OnQ) - Advanced Features
- Audience Builder (OnQ) - How To Query Customers
- Audience Builder (OnQ) - How to Query on Categories & Tags
- Audience Builder (OnQ) - Match Evaluation
- Audience Builder (OnQ) - Overview
- Audience Builder (OnQ) - Query Result Outputs
- Reports - Audience Builder (OnQ) Reporting
-
-
-
-
-