brandAbbreviation is the abbreviation for the brand customerId is the internal customer id (encrypted customer id may also be used)
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.
Retrieves a record containing all demographic information about the customer.
Field Definition
The following tables describe the hierarchical data elements.
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.
CustomerDemographics Elements
Element Name
Description
Customer
Element containing an http reference to the owning customer resource.
CustomerDemographic
each CustomerDemographic element contains all demographic information.
CustomerDemographic Elements
Element Name
Always Returned…
Data type
Description
Id
No
unique customer demographic identifier
DemographicId
No
integer that defines the demographic the responses are gathered for
DemographicType
No
integer – see Additional Information for the list of values and their descriptions
DemographicAge
No
integer – The number of years since the demographic was collected for this customer. The “year” is calculated based on the product’s audit cycle.
ValueId
Yes
the individual response value, if the response/data was for a single-response or a multiple-response demographic.
ValueText
Yes
the individual response value, if the response/data was for a text-response demographic.
ValueDate
Yes
the individual response value, if the response/data was for a date-response demographic.
WriteInDesc
Yes
String
If the Demographics Value “Type” is an “Other” response, and a text answer is being stored for this “Other” value, then the text answer will be returned.
AlternateId
No
String
An id that can be used to uniquely identify this demographic(perhaps in your content management system).
ChangedDate
no
Date & time record last changed. yyyy-MM-dd HH:mm:ss format. Example: 2010-03-08 21:23:34.
Response
HTTP Response Codes
Status
Description
200 OK
The request has succeeded. See Example Response below.
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.
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 your Omeda Account Representative if the issue continues.