Get campaign attendees

Description

Retrieves campaign attendees sorted by firstName and lastName ascendent

HTTP Method

GET

Path

/campaign/{identifier}/attendees

Authentication

Requires an authenticated user.

Parameters

Table 12.  Parameters for " Get campaign attendees "

NameTypeValue TypeDescription
identifierPATHlongthe ID of the campaign.
filterByQUERYString(optional) used to retrieve just attendees mathing the serching criterion, should be at least 2 chars long
authTokenQUERYString(optional) should only be provided if the request is performed without an account authenticated (for example when clicking on a link in an email)
extendedSearchQUERYBoolean(optional) 'true' to search in survey answers and extra profile fields
searchInParentQUERYboolean(optional) true to return visitors found in the parent campaign, if the parent settings allows searching in it's visitors list.
filterPropertiesQUERYString(optional) a JSON formated string containing the attendees properties/values and logical operation to be used for filtering the attendees list.
filterSurveyAnswersQUERYString(optional) a JSON formated string containing the questions, answers and logical operation to be used for matchmaking.
objectCategoryIdQUERYLong(optional) if provided will only return attendees having assigned this object category
includeSubCategoriesQUERYboolean(optional) if 'true' it will also include attendees having subcategories of the provided 'objectCategoryId'
startIndexQUERYint(optional) retrieve attendee starting from the provided index, (default is '0')
maxResultsQUERYint(optional) retrieve only this maximum number of attendees, (default is 100)
onlyMyConnectionsQUERYboolean(optional) true to return campaign visitors the logged in user is connected with.
hasNotesQUERYBoolean(optional) true to return campaign visitors for which the logged in user has written some notes. Ignored if not provided.
hasFavoriteQUERYBoolean(optional) true to return campaign visitors for which the logged in user has marked them as favorites. Ignored if not provided.
meetingsScheduledStatusQUERYString(optional) to consider campaign visitors for which the logged in user has this meetings statuses
sinceLastCheckQUERYlong(optional) number of seconds since the last time this endpoint was queried. Will only return attendees that changed in this number of seconds. It will only be taken in consideration if no 'filterBy' parameter is provided.
addSecurityHashesQUERYboolean(optional) to return sensitive data hashes to be used by clients for matching users
fullDetailsQUERYboolean(optional) set on true if you want to return also the leads info and other info for the campaign attendees. The requester should be an owner of the campaign and should have permission for viewing this information or just location and some other lest sensitive info will be returned.
displayActivitySettingsQUERYboolean(optional) 'true' to return also the activity settings of attendees (default is 'false' )
displayBadgeUrlQUERYboolean(optional) 'true' to return also the printed badge URL (default is 'false' ). It only works if fullDetails is true.
includeDeletedQUERYboolean(optional) 'true' to retrieve also removed from campaign attendees (default is 'false' )
includeCompatibilityScoreQUERYboolean(optional) 'true' to retrieve also the survey compatibility score between the account making the request and the returned attendees (default is 'false' )
includeMatchedAnswersQUERYBoolean(optional) 'true' to include in the response also the survey matched answers (default is 'false' )
includeSurveyAnswersQUERYBoolean(optional) 'true' to include in the response also the survey answers the logged in user has permission to view.Will be ignored if 'includeMatchedAnswers' is provided (default is 'false' )
includeTotalResultsQUERYboolean(optional) 'true' to include in the response the total number of attendees found base on the filtering parameters (default is 'false' )
displayMediaSizeQUERYString(optional, defaults to 's') specify the thumbnail size that should be returned for an attendee.Supported sizes are 'xs'(30x30 pixels), 's'(75x75), 's2'(100x100), 'm'(150x150).
displayDefaultMediaQUERYboolean(optional) 'true' to include in the response the default thumbnail, if none is found for an attendee. (default is 'false' )
orderByQUERYString(optional) specify a sort order.(0 - default sort order(LastName FirstName), 1 - by the time when the attendees was added to the campaign, 2 - title, 3 - organization name, 4 - city, 5 - state, 6 - country, 7 - compatibility, 8 - last collected date )
orderModeQUERYString(optional) specify a sort order mode.('asc' - default sort order mode, 'desc' - sort by orderBy and descendent mode)
processAllowScheduleMeetingQUERYboolean(optional) process the information which tells for what result item the requester can or not schedule meetings with it

Error Codes

100000 ( Campaign )

An unhandled exception has occured.

100003 ( Campaign )

The logged in account is not linked to the requested campaign

100004 ( Campaign )

The campaign doesn't exist or is inactive

100005 ( Campaign )

Don't have the permission to execute this request

100032 ( Campaign )

Invalid survey filter JSON object provided.

100035 ( Campaign )

Invalid filter properties JSON object provided.

150001 ( Common )

The endpoint requires an authenticated account

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="campaignAttendees">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="totalResults" type="xs:int" minOccurs="0"/>
        <xs:element name="attendee" nillable="true" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="accountId" type="xs:long"/>
              <xs:element name="identityId" type="xs:long"/>
              <xs:element name="campaignId" type="xs:long"/>
              <xs:element name="extRefId" type="xs:string" minOccurs="0"/>
              <xs:element name="staffExhibitorId" type="xs:long" minOccurs="0"/>
              <xs:element name="email" type="xs:string" minOccurs="0"/>
              <xs:element name="firstName" type="xs:string" minOccurs="0"/>
              <xs:element name="lastName" type="xs:string" minOccurs="0"/>
              <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
              <xs:element name="organizationName" type="xs:string" minOccurs="0"/>
              <xs:element name="organizationTitle" type="xs:string" minOccurs="0"/>
              <xs:element name="locality" type="xs:string" minOccurs="0"/>
              <xs:element name="country" type="xs:string" minOccurs="0"/>
              <xs:element name="region" type="xs:string" minOccurs="0"/>
              <xs:element name="mobilePhone" type="xs:string" minOccurs="0"/>
              <xs:element name="workPhone" type="xs:string" minOccurs="0"/>
              <xs:element name="collectedCount" type="xs:long" minOccurs="0"/>
              <xs:element name="emailCrc" type="xs:long" minOccurs="0"/>
              <xs:element name="qrCodeCrc" type="xs:long" minOccurs="0"/>
              <xs:element name="hasDeviceLinked" type="xs:boolean" minOccurs="0"/>
              <xs:element name="invalidEmail" type="xs:boolean" minOccurs="0"/>
              <xs:element name="deleted" type="xs:boolean" minOccurs="0"/>
              <xs:element name="canBeInvitedToMeeting" type="xs:boolean" minOccurs="0"/>
              <xs:element name="badgeUrl" type="xs:anyURI" minOccurs="0"/>
              <xs:element name="connection" type="tns:BaseObjectConnection" minOccurs="0"/>
              <xs:element name="leadSettings" type="tns:BaseLeads" minOccurs="0"/>
              <xs:element name="activitySettings" type="tns:ActivitySettings" minOccurs="0"/>
              <xs:element name="category" type="tns:BaseObjectCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
              <xs:element name="systemCategory" type="tns:BaseObjectCategory" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
              <xs:element name="survey" type="tns:MatchedSurvey" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:element name="leadSettings">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseLeads">
          <xs:sequence/>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="visitorBusinessCard">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:ScannedBusinessCard">
          <xs:sequence/>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="BaseObjectConnection">
    <xs:sequence>
      <xs:element name="type" type="xs:string"/>
      <xs:element name="status" type="xs:string"/>
      <xs:element name="note" type="xs:string"/>
      <xs:element name="keywords" type="tns:Keywords" minOccurs="0"/>
      <xs:element name="firstCollectedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="lastCollectedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="firstViewedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="lastViewedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="latitude" type="xs:double" minOccurs="0"/>
      <xs:element name="longitude" type="xs:double" minOccurs="0"/>
      <xs:element name="favorite" type="xs:boolean" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Keywords">
    <xs:sequence>
      <xs:element name="keyword" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseLeads">
    <xs:sequence>
      <xs:element name="leadQuestion" type="tns:LeadQA" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="scannedBusinessCardUrl" type="xs:string" minOccurs="0"/>
      <xs:element name="notes" type="xs:string" minOccurs="0"/>
      <xs:element name="lastUpdatedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="scannedBusinessCard" type="tns:ScannedBusinessCard" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="LeadQA">
    <xs:sequence>
      <xs:element name="leadQuestionId" type="xs:long"/>
      <xs:element name="leadAnswerId" type="xs:long"/>
      <xs:element name="extraAnswerId" type="xs:long" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="leadAnswerText" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="ScannedBusinessCard">
    <xs:sequence>
      <xs:element name="mediaId" type="xs:long"/>
      <xs:element name="url" type="xs:string"/>
      <xs:element name="position" type="xs:long"/>
      <xs:element name="default" type="xs:boolean" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="ActivitySettings">
    <xs:sequence>
      <xs:element name="setting" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="type" type="xs:string"/>
            <xs:element name="objectTypeId" type="xs:long" minOccurs="0"/>
            <xs:element name="objectCategoryId" type="xs:long" minOccurs="0"/>
            <xs:element name="maxValue" type="xs:int"/>
            <xs:element name="minValue" type="xs:int"/>
            <xs:element name="value" type="xs:int" minOccurs="0"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="BaseObjectCategory">
    <xs:sequence>
      <xs:element name="id" type="xs:long"/>
      <xs:element name="parentId" type="xs:long" minOccurs="0"/>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="namePlural" type="xs:string"/>
      <xs:element name="system" type="xs:boolean" minOccurs="0"/>
      <xs:element name="systemPath" type="xs:string" minOccurs="0"/>
      <xs:element name="position" type="xs:int"/>
      <xs:element name="badgeColor" type="xs:string" minOccurs="0"/>
      <xs:element name="usedCount" type="xs:long" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="MatchedSurvey">
    <xs:sequence>
      <xs:element name="surveyTypeId" type="xs:long"/>
      <xs:element name="score" type="xs:double" minOccurs="0"/>
      <xs:element name="answer" type="tns:MatchedSurveyAnswer" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="MatchedSurveyAnswer">
    <xs:sequence>
      <xs:element name="questionId" type="xs:long"/>
      <xs:element name="answerId" type="xs:long" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="answerText" type="xs:string" minOccurs="0"/>
      <xs:element name="score" type="xs:double"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="ConnectionType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Contact"/>
      <xs:enumeration value="Object"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ConnectionStatus">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Uncollected"/>
      <xs:enumeration value="New"/>
      <xs:enumeration value="Collected"/>
      <xs:enumeration value="Sponsor"/>
      <xs:enumeration value="Demo"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="ActivitySettingType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="DEFAULT"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<campaignAttendees xmlns="http://xsd.poken.com">
  <attendee>
    <accountId>2018229</accountId>
    <identityId>2018664</identityId>
    <firstName>Joe</firstName>
    <lastName>Doe</lastName>
    <thumbnail>https://d3759s1c6gf66q.cloudfront.net/u/2018229/2018664/nnrqQLMWCEPOva0pFvagXDlS2Nfe/150x150.jpg</thumbnail>
    <collectedCount>4</collectedCount>
    <connection>
      <type>Contact</type>
      <status>New</status>
      <firstCollectedDate>2012-04-27T13:25:47.595+02:00</firstCollectedDate>
      <lastCollectedDate>2012-04-27T13:25:47.595+02:00</lastCollectedDate>
      <favorite>false</favorite>
    </connection>
  </attendee>
  <attendee>
    <accountId>614323</accountId>
    <identityId>614083</identityId>
    <firstName>Tigruta</firstName>
    <lastName>Tigrisor</lastName>
    <thumbnail>https://d3759s1c6gf66q.cloudfront.net/u/614323/614083/fiPalbORnzSwrVsp7m249FUI8T3J/150x150.jpg</thumbnail>
    <collectedCount>29</collectedCount>
  </attendee>
</campaignAttendees>