Summary

This API provides capabilities to retrieve and add Behavior “Actions” defined for a given brand.

General Technical Requirements

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

HTTP Headers

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.content-typea content type supported by this resource. See Supported Content Types for more details. If omitted, the default content type is application/json.

Content Type

If omitted, the default 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.

Supported HTTP Methods

There are two HTTP methods supported:

1. POST : for creating a new Behavior Action

2. PUT : for updating a Behavior Action

Field Definition

The following tables describe the data elements present on the requests and responses 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.

Behavior Action Elements

Create Individual Behavior Action

An HTTP POST creates a new Behavior Action for a given brand. See W3C’s POST specs for details.

Request URI

For Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/behavior/action/*

For Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/behavior/action/*

Request

POST requests, by their nature, will not have an Id element, since POST is reserved for creating new elements, and the service governs the allocation of ids. There is no need to send in a StatusCode in the request since the service assumes the Behavior Action you are creating will be active.

Example Request

{ 
   "Description":"Attended Seminar"
}

Response – Success

Upon successful creation of a Behavior Action, an HTTP 200 will be issued. The response has a ResponseInfo element with one sub-element, a Id element, which is the Id for the Behavior Action.

HTTP Response Codes

Example Response

{
  "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "ResponseInfo":[
    {
      "Id":8907512
    }
  ]
}

Response – Failure

If an error occurs repeatedly, please contact your Omeda representative.

HTTP Response Codes

Example Response

{
  "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "Errors" : [
    {
      "Error": "A Behavior Action with that name already exists. The associated Behavior Action Id is 546783."
    }
  ]
}

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.

A Behavior Action with that name already exists.  The associated Behavior Action Id is {Behavior Action ID}.

Update Individual Behavior Action

An HTTP PUT updates a Behavior Action for a given brand. See W3C’s PUT specs for details. The only element that will be allowed to be updated is StatusCode.

Request URI

For Production: https://ows.omeda.com/webservices/rest/brand/{brandAbbreviation}/behavior/action/*

For Testing: https://ows.omedastaging.com/webservices/rest/brand/{brandAbbreviation}/behavior/action/*

Request

PUT requests indicates an update request for this web service. Service will accept the Id element and the StatusCode that you want to change it to.

Example Request

{
  "Id": 3476982,
  "StatusCode": 0
}

Response – Success

Upon successful update of a Behavior Action, an HTTP 200 will be issued. The response has a ResponseInfo element with one sub-element, a message element, which will simple return Update successful.

HTTP Response Codes

Example Response

{
  "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "ResponseInfo":[
    {
      "message":"Update successful"
    }
  ]
}

Response – Failure

If an error occurs repeatedly, please contact your Omeda representative.

HTTP Response Codes

Example Response

{
  "SubmissionId" : "C95AE90C-BEC6-41F2-91E2-2BA9168D1D1F",
  "Errors" : [
    {
      "Error": "A Behavior Action Id 1378903 was not found in your database"
    }
  ]
}

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.

A Behavior Action Id {Behavior Action ID} was not found in your database
The Behavior Action Id {Behavior Action ID} was already active, no update made
The Behavior Action Id {Behavior Action ID} was already inactive, no update made