Store Behavior Action
- Bettina Lippisch
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:
POST : for creating a new Behavior Action
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
Element Name | Data Type | Description |
|---|---|---|
Id | Integer | Behavior Action Identifier |
Description | String | Description of the Behavior Action. |
StatusCode | Integer | 1 = Active, 0 = Inactive |
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
Status | Description |
|---|---|
200 OK | The request has succeeded. |
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
Status | Description |
|---|---|
400 Bad Request | Typically, this error occurs when the request does not follow the specifications. |
403 Forbidden | Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid. |
404 Not Found | Typically, this error occurs with a malformed URL or the resource that is searched for is not found. |
405 Method Not Allowed | Typically, this error occurs when the resource accessed is not allowed by the HTTP Method utilized. Make sure you employ the correct HTTP Method (POST) for this request. |
500 Internal Server Error | In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact Omeda Account Representative. |
Example Response
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.
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
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
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
Status | Description |
|---|---|
200 OK | The request has succeeded. |
Example Response
Response – Failure
If an error occurs repeatedly, please contact your Omeda representative.
HTTP Response Codes
Status | Description |
|---|---|
400 Bad Request | Typically, this error occurs when the request does not follow the specifications. |
403 Forbidden | Typically, this error occurs when the credentials are erroneous. Potentially, an incorrect x-omeda-appid. |
404 Not Found | Typically, this error occurs with a malformed URL or the resource that is searched for is not found. |
405 Method Not Allowed | Typically, this error occurs when the resource accessed is not allowed by the HTTP Method utilized. Make sure you employ the correct HTTP Method (PUT) for this request. |
500 Internal Server Error | In the rare case that there is a server-side problem, this response will be returned. This generally indicates a problem of a more serious nature, and submitting additional requests may not be advisable. Please contact Omeda Account Representative. |
Example Response
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.
Table of Contents
- 1 Summary
- 2 General Technical Requirements
- 2.1 HTTP Headers
- 2.2 Content Type
- 2.3 Supported HTTP Methods
- 3 Field Definition
- 4 Create Individual Behavior Action
- 4.1 Request URI
- 4.2 Request
- 4.2.1 Example Request
- 4.3 Response – Success
- 4.3.1 HTTP Response Codes
- 4.3.2 Example Response
- 4.4 Response – Failure
- 4.4.1 HTTP Response Codes
- 4.4.2 Example Response
- 4.4.3 Possible Error Messages
- 5 Update Individual Behavior Action
- 5.1 Request URI
- 5.2 Request
- 5.2.1 Example Request
- 5.3 Response – Success
- 5.3.1 HTTP Response Codes
- 5.3.2 Example Response
- 5.4 Response – Failure
- 5.4.1 HTTP Response Codes
- 5.4.2 Example Response
- 5.4.3 Possible Error Messages