All Versions

Version 1
Version 2


Page tree

Supplier API v2

Skip to end of metadata
Go to start of metadata

Definition of our demographic data points

Table of Contents

Version 1.0

Data Model

NameTypeDescription
_links#_linksObject containing links to related resources
_metadata#_metadataMetadata describing this resource
demographicIdintegerID of this Demographic
demographicNamestringThe internal name used for this demographic
demographicTypeenumeration
NameDescription
questionThis is a question that will be asked to members as needed. Please refer to the Question Text.
geographicThis is geographic data that is derived automatically based on the member's postal code. Members will never be directly asked questions of this type and you cannot set demographics of this type for a member using this API. Instead, you should set the members postal code. The API will return the member's current value for these demographics in GET requests.
derivedA derived data point other than geographic data that is detected automatically by the system. For example, is the member currently using a mobile device. Members will never be directly asked questions of this type and you cannot set demographics of this type for a member using this API. The API will return the member's last known values for these demographics in GET requests.
ageA special derived demographic based on the member's birth date. Members will never be directly asked this question and you cannot set this demographic for a member using this API. Instead, you should set the members birth date. The API will return the member's current value for this demographic in GET requests.
responseTypeenumeration
NameDescription
single-punchA member may have at most one response for single-punch questions
multi-punchA member may have one or more responses selected for multi-punch questions
standardDemographicboolean

If true, this is a standard demographic that will be commonly used across many target definitions.

When calling the demographics endpoint to retrieve a list of all demographics, the API will only return ones where standardDemographic = true.

statusenumeration
NameDescription
activeThe demographic is currently active in our system and may be used in any current or future target definitions
inactiveThe demographic is no longer active and will not be used on any future target definitions. However, it may still be in use on an existing target and may still be returned in the list of a member's demographics.
responseExpirationDaysintegerThe number of days that we consider a member's response to this question to be current. We will re-ask the question the next time we need a value for this demographic for any member whose response is more than responseExpirationDays old. A null value indicates that the member's response will never expire.
textobjectThis will contain a list of the supported languages and translated text for this question. Only demographics of demographicType question will have text. Text will be null for all other demographicType .

Examples


{
  "_links": {
    "self": {
      "href": "https://qa-supplier.cmix.com/api/v2/demographics/16",
      "class": "demographics",
      "identifier": 16
    },
    "values": {
      "href": "https://qa-supplier.cmix.com/api/v2/demographics/16/values",
      "class": "values"
    }
  },
  "_metadata": {
    "created": "2009-08-03T14:11:56Z",
    "lastModified": "2018-11-16T19:09:11Z"
  },
  "demographicId": 16,
  "demographicName": "Standard Marital Status",
  "demographicType": "question",
  "responseType": "single-punch",
  "standardDemographic": true,
  "status": "active",
  "responseExpirationDays": null,
  "text": {
    "DE": "Wie ist Ihr Familienstand?",
    "EN": "What is your marital status?",
    "ES": "¿Cuál es su estado civil?",
    "FR": "Quel est votre état civil?",
    "IT": "Qual è il suo stato civile?",
    "NL": "Wat is uw burgerlijke staat?",
    "PT": "Qual é o seu estado civil?",
    "ZH": "??????????"
  }
}


Links to related resources. Links are provided only in cases where the linked resource exists in the context of this target.

NameTypeDescription
selfLink

Self-referencing link to the current object

valuesLinkLink to the acceptable response values for this demographic

Examples

"self": {
  "href": "https://qa-supplier.cmix.com/api/v2/demographics/16",
  "class": "demographics",
  "identifier": 16
},
"values": {
  "href": "https://qa-supplier.cmix.com/api/v2/demographics/16/values",
  "class": "values"
}

_metadata

NameTypeDescription
createddatetimeWhen this demographic was created
lastModifieddatetimeWhen the last modifications were made to this demographic

Examples

{
  "created": "2018-08-21T10:34:16Z",
  "lastModified": "2018-08-22T13:39:13Z",
}

 

  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.