Search the Omeda Knowledge Base

< All Topics

Deployment Type Lookup by Brand API


This API provides capabilities to retrieve the defined deployment types of a single brand. This service is useful for building your own data mapping service when reading or writing from/to other Omeda services.

General Technical Requirements

The following technical requirements apply to all requests for this API.

Base Resource URI



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

Supported HTTP Methods

There is one HTTP method supported:

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

Deployment Type Lookup by Brand

Retrieves all deployment types of a single brand.

Field Definition

The following tables describe the hierarchical data elements present on the response from the API.

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).
DeploymentTypesYesListA list of DeploymentType elements. These decode the opt-out codes that emails are sent out under.

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.


HTTP Response Codes

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.


  "Description":"AppDev Today",
      "Description":"Framework Building",
      "AlternateId":"Frmwk Bldg",


         "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

DeploymentTypes – StatusCode

Table of Contents
Scroll to Top