All Versions

Version 1
Version 2


Page tree

Supplier API v2

Skip to end of metadata
Go to start of metadata

List of the acceptable values for a demographic

Table of Contents

Version 1.0

Data Model

NameTypeDescription
_links#_linksObject containing links to related resources
_metadata#_metadataMetadata describing this resource
demographicValueId
integer

ID of this value

demographicValueId is unique system-wide across all demographics

demographicValueId is not consistent between the Production and Sandbox environments! Please be sure to map values appropriately!

value
string

System assigned value, unique within this demographic. This may be a numeric sequence or a string value.

For standard demographics, the value will be consistent between the Production and Sandbox environments.

descriptionstring

Descriptive text for this value.

displayOrderinteger

Suggested order for displaying the values when asking the question to a member

textobjectThis will contain a list of the supported languages and translated text for this question. Only values for demographics of demographicType question will have text. Text will be null for all other demographicType .

Examples

Example value for a demographic of demographicType question.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/values/41814",
      "class": "values",
      "identifier": 41814
    },
    "parent": {
      "href": "https://supplier.cmix.com/api/v2/demographics/16",
      "class": "demographics",
      "identifier": 16
    }
  },
  "_metadata": {
    "created": "2009-08-03T03:45:59Z",
    "lastModified": "2017-12-08T05:41:08Z"
  },
  "demographicValueId": 41814,
  "value": "1",
  "description": "Married",
  "displayOrder": 3,
  "text": {
    "DE": "Verheiratet",
    "EN": "Married",
    "ES": "Casado(a)",
    "FR": "Marié(e)",
    "IT": "Sposato",
    "NL": "Getrouwd",
    "PT": "Casado",
    "ZH": "??"
  }
}

Example value for a demographic of demographicType geographic.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/values/9408067",
      "class": "values",
      "identifier": 9408067
    },
    "parent": {
      "href": "https://supplier.cmix.com/api/v2/demographics/19541",
      "class": "demographics",
      "identifier": 19541
    },
    "postalcodes": {
      "href": "https://supplier.cmix.com/api/v2/values/9408067/postalcodes",
      "class": "postalcodes"
    }
  },
  "_metadata": {
    "created": "2017-05-02T17:26:57Z",
    "lastModified": "2017-12-08T05:57:51Z"
  },
  "demographicValueId": 9408067,
  "value": "547",
  "description": "TOLEDO",
  "displayOrder": 48,
  "text": null
}

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.

parentLinkLink to the demographic to which this value belongs.
postalcodesLinkFor geographic demographic values, this is a link to the list of postalcodes defined for this value.

Examples

Example _links for a value belonging to a demographic of demographicType question.

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

Example _links for a value belonging to a demographic of demographicType geographic.

"self": {
  "href": "https://supplier.cmix.com/api/v2/values/9408067",
  "class": "values",
  "identifier": 9408067
},
"parent": {
  "href": "https://supplier.cmix.com/api/v2/demographics/19541",
  "class": "demographics",
  "identifier": 19541
},
"postalcodes": {
  "href": "https://supplier.cmix.com/api/v2/values/9408067/postalcodes",
  "class": "postalcodes"
}

_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.