Search the Omeda Knowledge Base
Behavior Lookup By Id
- Knowledge Base Home
- Documentation
- API & Webservices
- Brand Lookup APIs
- Behavior Lookup By Id
Summary
This API provides capabilities to retrieve a single Behavior. You would use this service to look up a behavior using the Behavior 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}/behavior/{behaviorId}/* Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/behavior/{behaviorId}/*
- brandAbbreviation
- is the abbreviation for the brand
- behaviorId
- is the known behavior id
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 Behavior By Id
An HTTP GET retrieves a single Behavior for a brand, by it’s ID.
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.
Behavior Elements
Element Name | Always Returned | Data Type | Description |
---|---|---|---|
Id | Yes | Integer | Behavior Identifier |
ActionId | Yes | Integer | Behavior Action Identifier – all behaviors must belong to a behavior action, which is predefined in the database. Some examples of behavior actions are “View”, “Download”, “Registered”, “Attend” – each of which contains has numeric identifier. |
Description | Yes | String | Description of the Behavior. |
AlternateId | No | String | An id that can be used to uniquely identify this behavior (perhaps in your content management system). |
OmedaProductId | No | Integer | Links the Behavior to a specific Product defined in the database. |
Response
When getting a single behavior, the Behaviors element is omitted and one behavior is returned.
HTTP Response Codes
Status | Description |
---|---|
200 OK | The request has succeeded. See Example Response below. |
404 Not Found | In the event the Behavior is not found, an HTTP 404 (not found) response will be returned. |
Example Response
{ "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F", "Behavior":[ { "Id":41237, "TypeId":11, "Description":"Trade Show 2010 - No Show", "AlternateId":"TRADE_SHOW_2010_NO_SHOW" } ] }
-
-
-
- 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
-
-
-
-
-