Brand Group Lookup
- Bettina Lippisch
Summary
This API provides capabilities to retrieve the Information defined for a given GroupId.
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}/group/{groupId}*
Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/group/{groupId}*
brandAbbreviation is the abbreviation for the brand groupId is the known group 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 Group
Retrieves all information for the specified GroupId.
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.
Field Definition
The following tables describe the hierarchical 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.
Group Elements
Element Name | Always Returned… | Data Type | Description |
|---|---|---|---|
GroupTypeCode | Yes | Integer | The brand identifier. |
GroupName | Yes | String | The name of the brand. |
GroupCode | Yes | String | The abbreviation for the brand (used in most web service URLs). |
GroupAdminUserName | Yes | String | The count of all customers that are associated with the brand (regardless of status). |
PassPhrase | Yes | String | The count of all customers that are associated with the brand (regardless of status). |
GroupAdminCode | No | Integer | A list of Demographic elements. These define the customized information that is being collected about a customer for this brand. |
MaxMembers | No | Integer | A list of Product elements. These specify the products that can be associated with customers for this brand. |
ActiveMembers | No | Integer | A list of ContactType elements. These decode the different forms of contact a customer can have. |
RemainingMembers | No | Integer | A list of DeploymentType elements. These decode the opt-out codes that emails are sent out under. |
StatusCode | Yes | Integer | A list of DeploymentType elements. These decode the opt-out codes that emails are sent out under. |
Group Products Elements
Element Name | Always Returned… | Data Type | Description |
|---|---|---|---|
GroupProductId | Yes | Integer | The OmedaProductId associated with the group. |
GroupProductPrice | Yes | String | The price set for this Product. |
EarningCode | Yes | String | “” |
GroupExpireDate | Yes | Integer | The expire date set for this Product. |
Customers Elements
Element Name | Always Returned… | Data Type | Description |
|---|---|---|---|
OmedaCustomerId | Yes | Integer | This is the Omeda demographic value id, and the value used for the OmedaDemographicValue attribute when utilizing the Save Customer and Order API. |
FirstName | No | String | The name of the demographic value. |
LastName | No | Integer | Type of demographic value. See Demographic Value Types for the list of values and their descriptions |
EmailAddress | No | Integer | Order in which to display demographic items. If you would like this order to be adjusted, please contact your Account Representative. |
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":"C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
"Behavior":[
{
"Id":41234,
"ActionId":3,
"Description":"Trade Show 2010 - Attended",
"AlternateId":"TRADE_SHOW_2010_ATTENDED",
"ProductId":76
},
{
"Id":41235,
"ActionId":8,
"Description":"Trade Show 2010 - Onsite",
"AlternateId":"TRADE_SHOW_2010_ONSITE",
"ProductId":76
},
{
"Id":41236,
"ActionId":10,
"Description":"Trade Show 2010 - Pre-Registered",
"AlternateId":"TRADE_SHOW_2010_PRE_REGISTERED",
"ProductId":76,
"Category":[2,3,4]
},
{
"Id":41237,
"ActionId":11,
"Description":"Trade Show 2010 - No Show",
"AlternateId":"TRADE_SHOW_2010_NO_SHOW",
"ProductId":76,
"Category":[2,3,4]
}
]
} 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 Group
- 3.1 Field Definition
- 3.2 Field Definition
- 3.2.1 Group Elements
- 3.2.1.1 Group Products Elements
- 3.2.1.2 Customers Elements
- 3.2.1 Group Elements
- 3.3 Response
- 3.3.1 HTTP Response Codes
- 3.3.2 Example Response