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.
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.