Knowledge Base Categories
An api available to our omail clients.
For a given set of url parameters – the API will return the text or html content for a given omail deployment and specified split.
The following technical requirements apply to all requests for this API.
Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/content/lookup/{textOrHtml}/{trackingNumber}/{splitSequence}/* Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/omail/deployment/content/lookup/{textOrHtml}/{trackingNumber}/{splitSequence}/* |
brandAbbreviation is the abbreviation for the brand textOrHtml valid values are “text” or “html” and determine whether the API returns the text version of the deployment content or the html version of the deployment content. trackingNumber is the tracking number for the omail deployment. splitSequence is the split sequence of the omail deployment. If the deployment has multiple splits, you would pass ‘1’ to see split 1’s content, etc.
The HTTP header must contain the following elements: x-omeda-appid a unique id provided to you by Omeda to access your data. The request will fail without a valid id.
The content type is text/html.
There is one HTTP method supported: GET See W3C’s GET specs for details.
Table of Contents