Skip to content

Search the Omeda Knowledge Base

Brand Comprehensive Lookup Service

Summary

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.

Base Resource URI

Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/comp/*

Testing:    https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/comp/*
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:

  1. GET : See W3C’s GET specs for details.

Comprehensive Lookup by Brand

Retrieves all information about a single brand.

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.

Brand Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerThe brand identifier.
DescriptionYesStringThe name of the brand.
BrandAbbrevYesStringThe abbreviation for the brand (used in most web service URLs).
CustomerCountYesIntegerThe count of all customers that are associated with the brand (regardless of status).
DemographicsYesListA list of Demographic elements. These define the customized information that is being collected about a customer for this brand.
ProductsYesListA list of Product elements. These specify the products that can be associated with customers for this brand.
ContactTypesYesListA list of ContactType elements. These decode the different forms of contact a customer can have.
DeploymentTypesYesListA list of DeploymentType elements. These decode the opt-out codes that emails are sent out under.

Demographics Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerThis is the Omeda demographic id, and is the value used for the OmedaDemographicId attribute when utilizing the Save Customer and Order API.
DemographicTypeYesIntegerType of demographic. See Demographic Types for the list of values and their descriptions
DescriptionYesStringThe name of the demographic, and the value used for the ClientDemographicId attribute when utilizing the Save Customer and Order API.
DemoLegacyIdYesStringThis is the Demographic ID that is used in the Omeda’s V10 system.
DemographicValuesYesLista list of DemographicValue elements. These define the values associated with the customized demographic information that is being collected about a customer
AuditedProductsNoListThis 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.
OmedaWebformTextYesStringOmeda INTERNAL use only
OmedaWebformViewCodeYesIntegerOmeda INTERNAL use only. See View Codes for the list of values and their descriptions
OmedaWebformSequenceYesIntegerOmeda INTERNAL use only
DemographicValues Elements
Element NameAlways Returned…Data TypeDescription
IdYesIntegerThis is the Omeda demographic value id, and the value used for the OmedaDemographicValue attribute when utilizing the Save Customer and Order API.
DescriptionYesStringThe name of the demographic value.
ShortDescriptionYesStringThe short name of the demographic value.
DemographicValueTypeYesIntegerType of demographic value. See Demographic Value Types for the list of values and their descriptions
AlternateIdYesStringThe 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.
SequenceYesIntegerOrder in which to display demographic items. If you would like this order to be adjusted, please contact your Account Representative.
OmedaWebformTextYesStringOmeda INTERNAL use only
OmedaWebformViewCodeYesIntegerOmeda INTERNAL use only. See View Codes for the list of values and their descriptions
OmedaWebformSequenceYesIntegerOmeda INTERNAL use only

Products Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerThe product identifier.
DescriptionYesStringName of the product.
ProductTypeYesInteger“Type” of Product. See Product Types.
AlternateIdYesStringThis is the Product ID that is used in Omeda’s V10 system.
FrequencyNoIntegerFrequency of the product issues per year.
FrequencyTypeNoStringThe possible frequency types (Daily – DY, Weekly – WK, Monthly – MO, Yearly – YR, bi-weekly – BIW, bi-monthly – BIM, Manual – MA)
DeploymentTypeIdYesIntegerIf the product is linked to a DeploymentType (Omail), then this ID will be returned.
MarketingClassesNoListA list of MarketingClasses elements. These elements will only be returned if the Product Types is 1 (Magazine) or 2 (Newsletter) or 7 (Website).
IssuesNoListA list of Issues elements. These elements will only be returned if the Product Types is 1 (Magazine).
MarketingClasses Elements
Element NameAlways Returned…Data TypeDescription
IdYesIntegerMarketing class identifier.
DescriptionYesStringName of the marketing class.
ShortDescriptionYesStringA short name of the marketing class.
ClassIdYesStringMarketing class identifier associated with legacy products.
StatusCodeYesIntegerSee Marketing Class Statuses for a list of status codes and their associated values
Issues Elements
Element NameAlways Returned…Data TypeDescription
IdYesIntegerIssue identifier.
DescriptionYesStringA description for the Issue.
IssueDateYesDatetimeDate of the issue in yyyy-MM-dd format. Example: 2012-05-01.
AlternateIdYesStringOmeda’s legacy Issue ID.
StatusCodeYesByteSee Issue Status Codes for a list of status codes and their associated values.

ContactTypes Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerContact type identifier.
DescriptionYesStringName of the contact type. See Contact Types for detailed list of contact type descriptions.

DeploymentTypes Elements

Element NameAlways Returned…Data TypeDescription
IdYesIntegerDeployment type identifier.
NameYesStringThe name of the deployment type.
DescriptionYesStringThe name of the deployment type.Use the Name field instead, this field will be depreciated soon!
LongDescriptionNoStringThe text description of the deployment type.
AlternateIdYesStringThe client’s associated value to Omeda’s deployment type identifier.
StatusCodeYesByteSee Deployment Type Status Codes for a list of status codes and their associated values.

Response

HTTP Response Codes

StatusDescription
200 OKThe request has succeeded. See Example Response below.
404 Not FoundIn the event no Brand Information is found, an HTTP 404 (not found) response will be returned.

Success

{ 
  "SubmissionId":"C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "Id":3000,
  "Description":"AppDev Today",
  "BrandAbbrev":"APPDEV",
  "CustomerCount":4,
  "Demographics":[
    {
      "Id":1,
      "DemographicType":1,
      "Description":"Job Title",
      "AuditedProducts":[
         101,
         102,
         103
      ],
      "DemographicValues":[
        {
          "Id":1, 
          "Description":"Owner, President, CEO", 
          "ShortDescription":"Owner",
          "AlternateId":"02"
        },       
        { 
          "Id":2, 
          "Description":"CIO, CFO, CXO", 
          "ShortDescription":"CIO, CFO, CXO",
          "AlternateId":"04"
        },
        {
          "Id":3, 
          "Description":"Vice President", 
          "ShortDescription":"VPs",
          "AlternateId":"05"
        },
        { 
          "Id":4, 
          "Description":"Management", 
          "ShortDescription":"Management",
          "AlternateId":"09"
        }
      ]
    },
    {
      "Id":2,
      "DemographicType":2,
      "Description":"Technology",
      "DemographicValues":[
        {
          "Id":11, 
          "Description":"Java", 
          "ShortDescription":"Java",
          "AlternateId":"23"
        },
        { 
          "Id":12, 
          "Description":"C#", 
          "ShortDescription":"C#",
          "AlternateId":"34"
        },
        { 
          "Id":13, 
          "Description":"C, C++", 
          "ShortDescription":"C, C++",
          "AlternateId":"35"
        }
      ]
    }
  ],
  "Products":[
    { 
      "Id":1, 
      "Description":"AppDev Today Web Access", 
      "ProductType":3, 
      "MarketingClasses":[
        {
          "StatusCode":0,
          "ShortDescription":"Need More Info",
          "ClassId":"2",
          "Description":"Need More Information",
          "Id":24
        },
        {
          "StatusCode":1,
          "ShortDescription":"Frmwk",
          "ClassId":"3",
          "Description":"Framework",
          "Id":22
        }
      ],
      "Issues":[
        {
          "Id":478437,
          "Description":"March 2012 Issue",
          "IssueDate": "2012-05-01",
          "AlternateId": "201205",
          "StatusCode": 30
        },
        {
          "Id":478438,
          "Description":"April 2012 Issue",
          "IssueDate": "2012-04-01",
          "AlternateId": "201205",
          "StatusCode": 30
        }
      ]
    },
    { 
      "Id":2, 
      "Description":"AppDev Today Magazine", 
      "ProductType":1
    }
  ],
  "ContactTypes":[ 
    { 
      "Id":100, 
      "Description":"Business Address" 
    },
    { 
      "Id":200, 
      "Description":"Business Phone" 
    },
    { 
      "Id":300, 
      "Description":"Primary Email" 
    },
    { 
      "Id":310, 
      "Description":"Secondary Email" 
    }
  ],
  "DeploymentTypes":[
    {
      "Id":2344,
      "Description":"Framework Building",
      "AlternateId":"Frmwk Bldg",
      "StatusCode":1
    }
  ]
}

Failure

{
   "SubmissionId":"ec0c2ba6-13f4-4934-8efa-74c2ccb33f1d",
   "Errors":[
      {
         "Error":"Brand 12345 was not found."
      }
   ]
}
Possible Error Messages

In the event of an error, an error response will be returned. Here are some of the possible responses you might receive.

Brand {brandId} was not found.

Additional Information

Demographics – DemographicType

StatusCodeDescription
1A single-choice-allowed type of question. (Two or more choices – one answers)
2A multiple-choice-allowed type of question. (Two or more choices – many answers)
3An open-form short answer question. (No choices – text input)
5A yes/no answer.
6A date answer.
7A whole number answer.
8A decimal answer.

Demographics – DemographicValueType

StatusCodeDescription
0Standard Choice: Type indicating a single-choice-allowed type of question. (Two or more choices – one answers).
3None-of-the-above Choice: None-of-the-above choice value type. A type of standard choice whose selection may force some special validation.
4‘Other’ Choice: This value type will represent the “Other” option ( Open ended Coding ).

MarketingClasses – StatusCode

StatusCodeDescription
0Customers with this StatusCode may or may not receive the product.
1Customers with this StatusCode will receive the product.

DeploymentTypes – StatusCode

StatusCodeDescription
0Inactive
1Active

Issues – StatusCode

StatusCodeDescription
0Planned
10Open
20Locked
30Closed
40Current Supplement
45Current Supplement Closed
50In Progress
55In Progress Closed

Webforms – ViewCode

StatusCodeDescription
0Hidden
1Required
2Optional
Tags:
Table of Contents
Knowledge Base Feedback