Behavior Lookup Grouped By Product
- Bettina Lippisch
Summary
This API provides capabilities to retrieve the Behaviors for the associated Brand grouped by Product. For example, you might use it to keep your marketing database at Omeda in sync with your content taxonomy category.
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/byproduct/*
Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/behavior/byproduct/*
brandAbbreviation is the abbreviation for the brand
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 All Behaviors Grouped By Product
Retrieves all defined Behaviors for the brand, grouping them by Product.
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). |
ProductId | No | Integer | Links the Behavior to a specific Product defined in the database. |
Response
HTTP Response Codes
Status | Description |
|---|---|
200 OK | The request has succeeded. See Example Response below. |
404 Not Found | In the event no Behaviors are found, an HTTP 404 (not found) response will be returned. |
Example Response
{
"SubmissionId":"67c47245-d14f-4f84-acd6-c2331cfe9b63",
"Product":[
{
"Id":2,
"Description":"Trade Show 2012",
"Behavior":[
{
"Description":"Trade Show 2012 - Exhibited",
"TypeId":7,
"AlternateId":"TRADE_SHOW_2010_EXHIBITED",
"Id":20
},
{
"Description":"Trade Show 2012 - Attended",
"TypeId":10,
"Id":6
}
]
},
{
"Id":3,
"Description":"Media Communications",
"Behavior":[
{
"Description":"Attended",
"TypeId":6,
"AlternateId":"ALT_ID",
"Id":21
}
]
}
]
}Table of Contents