This API provides capabilities to retrieve information about a single brand, including its defined products, demographics, deployment types, and other cross referencing information. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services. Results from this API should be cached and then refreshed at an interval by the user. This API is not intended to be hit real time by web traffic or otherwise hit with a great frequency.
General Technical Requirements
The following technical requirements apply to all requests for this API.
brandAbbreviationis 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.JSONapplication/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.
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.
Brand Elements
Element Name
Always Returned…
Data Type
Description
Id
Yes
Integer
The brand identifier.
Description
Yes
String
The name of the brand.
BrandAbbrev
Yes
String
The abbreviation for the brand (used in most web service URLs).
CustomerCount
Yes
Integer
The count of all customers that are associated with the brand (regardless of status).
Demographics
Yes
List
A list of Demographic elements. These define the customized information that is being collected about a customer for this brand.
Products
Yes
List
A list of Product elements. These specify the products that can be associated with customers for this brand.
ContactTypes
Yes
List
A list of ContactType elements. These decode the different forms of contact a customer can have.
DeploymentTypes
Yes
List
A list of DeploymentType elements. These decode the opt-out codes that emails are sent out under.
Demographics Elements
Element Name
Always Returned…
Data Type
Description
Id
Yes
Integer
This is the Omeda demographic id, and is the value used for the OmedaDemographicId attribute when utilizing the Save Customer and Order API.
DemographicType
Yes
Integer
Type of demographic. See Demographic Types for the list of values and their descriptions
Description
Yes
String
The name of the demographic, and the value used for the ClientDemographicId attribute when utilizing the Save Customer and Order API.
DemoLegacyId
Yes
String
This is the Demographic ID that is used in the Omeda’s V10 system.
DemographicValues
Yes
List
a list of DemographicValue elements. These define the values associated with the customized demographic information that is being collected about a customer
AuditedProducts
No
List
This is a list of Product Ids that the demo is audited for. If the demo is not audited for any product, this will not be returned.
OmedaWebformText
Yes
String
Omeda INTERNAL use only
OmedaWebformViewCode
Yes
Integer
Omeda INTERNAL use only. See View Codes for the list of values and their descriptions
OmedaWebformSequence
Yes
Integer
Omeda INTERNAL use only
DemographicValues Elements
Element Name
Always Returned…
Data Type
Description
Id
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.
Description
Yes
String
The name of the demographic value.
ShortDescription
Yes
String
The short name of the demographic value.
DemographicValueType
Yes
Integer
Type of demographic value. See Demographic Value Types for the list of values and their descriptions
AlternateId
Yes
String
The client’s associated value to Omeda’s demographic value, and the value used for the ClientDemographicValue attribute when using the Save Customer and Order API.
Sequence
Yes
Integer
Order in which to display demographic items. If you would like this order to be adjusted, please contact your Account Representative.
OmedaWebformText
Yes
String
Omeda INTERNAL use only
OmedaWebformViewCode
Yes
Integer
Omeda INTERNAL use only. See View Codes for the list of values and their descriptions