All Versions

Version 1
Version 2


Page tree

Supplier API v2

Skip to end of metadata
Go to start of metadata

List of respondents who are excluded from participating in this target. 

Table of Contents

Version 1.0

Data Model

NameTypeDescription
_links_linksObject containing links to related resources
_metadata_metadataMetadata describing this resource
exclusionListIdintegerID of this exclusion list
indirectExclusionsarray of IndirectExclusionsArray of the targets whose participants must be excluded from participating in the survey to which this list is assigned. An empty array will be included if there are no indirect exclusions.
directExclusionsarray of DirectExclusionsList of member IDs who should be excluded. An empty array will be included if there are no direct exclusions.

While technically possible, it is highly unlikely that an exclusion list will contain both direct and indirect exclusions.

Examples

This is an example of an exclusion list with indirect exclusions.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/exclusions/104937",
      "class": "exclusions",
      "identifier": 104937
    }
  },
  "_metadata": {
    "created": "2018-08-21T10:34:16Z",
    "lastModified": "2018-08-22T13:39:13Z",
  },
  "indirectExclusions": [
    {
      "_metadata": {
        "created": "2018-10-04T14:45:55Z",
        "lastModified": "2018-10-04T14:45:55Z",
      },
      "sourceTargetId": 165437,
      "surveyStatuses" : [
        "survey-complete",
        "survey-terminate",
        "survey-over-quota"
      ]
    },
    {
      "_metadata": {
        "created": "2018-10-04T14:45:55Z",
        "lastModified": "2018-10-04T14:45:55Z",
      },
      "sourceTargetId": 165421,
      "surveyStatuses" : [
        "survey-complete"
      ]
    }
  ],
  "directExclusions": [ ]
}

 

This is an example with direct exclusions.

{
  "_links": {
    "self": {
      "href": "https://supplier.cmix.com/api/v2/exclusions/104937",
      "class": "exclusions",
      "identifier": 104937
    }
  },
  "_metadata": {
    "created": "2018-08-21T10:34:16Z",
    "lastModified": "2018-08-22T13:39:13Z",
  },
  "indirectExclusions": [ ]
  "directExclusions": [ 
    { 
      "memberId": "dhw873ww2q9wweh",
      "created": "2018-10-04T14:45:55Z",
      "lastModified": "2018-10-04T14:45:55Z"
    },
    { 
      "memberId": "4754yrrdfhgde7e",
      "created": "2018-10-04T14:45:55Z",
      "lastModified": "2018-10-04T14:45:55Z"
    },
    { 
      "memberId": "dgegud2374h47ed",
      "created": "2018-10-04T14:45:55Z",
      "lastModified": "2018-10-04T14:45:55Z"
    }
  ]
}

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

Examples

{
  "self": {
    "href": "https://supplier.cmix.com/api/v2/exclusions/104937",
    "class": "exclusions",
    "identifier": 104937
  }
}

_metadata

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

Examples

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

IndirectExclusions

Indirect exclusions are defined by the members who participated in other targets and had specific survey outcomes in those targets. The member list may be dynamic because the targets specified may still be in field. 

The statuses refer to the status within the survey. Anyone who disqualified during the pre-screening process is not a part of the exclusion list.

NameTypeDescription
sourceTargetIdintegerThe ID of a source target whose participants should be excluded from participating in destination targets which subscribe to this list.
surveyStatusesarray of SurveyStatuses
ValueDescription
survey-starteveryone from the target who started the survey, but did not finish (drop-off)
survey-completeeveryone from the target who completed the survey
survey-terminateeveryone from the target who was terminated from the survey
survey-over-quotaeveryone from the target who was rejected as an over quota

Examples

{
  "_metadata": {
    "created": "2018-10-04T14:45:55Z",
    "lastModified": "2018-10-04T14:45:55Z",
  },
  "sourceTargetId": 165437,
  "surveyStatuses" : [
    "survey-complete",
    "survey-terminate",
    "survey-over-quota"
  ]
}

DirectExclusions

Direct exclusions are a list of specific member ids who are explicitly excluded from this target.

NameTypeDescription
memberIdstringThe id of the member to exclude
created datetimeDate the member was added to the exclusion list
lastModifieddatetimeDate the member record was modified in this list

Examples

{
  "memberId": "1002376",
  "created": "2018-10-04T14:45:55Z",
  "lastModified": "2018-10-04T14:45:55Z"
}

 

  • No labels
Write a comment…