Get campaign objects

Description

Retrieves campaign objects basic information. The returned objects are sorted by name

HTTP Method

GET

Path

/campaign/{identifier}/objects

Authentication

Requires an authenticated user.

Parameters

Table 9.  Parameters for " Get campaign objects "

NameTypeValue TypeDescription
identifierPATHLongthe ID of the campaign.
objRefInObjectIdQUERYlong(optional) the ID of a campaign object. The response will only consider objects referenced by this object.
objectTypeQUERYString(optional) if provided will return only the objects having that type
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).
filterByQUERYString(optional) used to retrieve just objects 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)
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 objects having assigned this object category
includeSubCategoriesQUERYboolean(optional) if 'true' it will also include objects having subcategories of the provided 'objectCategoryId'
onlyMyConnectionsQUERYBoolean(optional) true to return campaign visitors the logged in user is connected with.
hasNotesQUERYBoolean(optional) true to return campaign objects for which the logged in user has written some notes. Ignored if not provided.
hasFavoriteQUERYBoolean(optional) true to return campaign objects for which the logged in user has marked them as favorites. Ignored if not provided.
meetingsScheduledStatusQUERYString(optional) to consider objects for which the logged in user has this meetings statuses
activeStatusQUERYBooleanif not provided all objects will be returned even if they are active or not, otherwise provide 'true' to get ONLY active objects or 'false' to get ONLY inactive objects. Status is computed based on object's start and end date, relative to the current time in the context of the campaign's timezone
fullDetailsQUERYboolean(optional) if 'true' it will set some extra fields. An example is the 'description' field which will not be returned otherwise.
specialFeatureQUERYString(optional) only available to internal API clients. Allows obtaining a list of campaign objects base on the special feature requested (possible values are 'surveyMatch' and 'availablePlaces'). Please note, some parameters have special meaning base on the value of this parameter.For 'availablePlaces' please provide valid 'startDate' and 'endDate' values
specialFeatureParamQUERYString(optional) only available to internal API clients. If 'specialFeature' is provided, we support recieving an extra parameter that makes sense in the context of the provided special feature
showBarcodeUrlQUERYboolean(optional) Retrieves the object's barcode url. Only available for some API clients.
includeInternalQUERYBoolean(optional) Include also objects marked as not to show in timeline or object library.
startDateQUERYlong(optional) UTC UNIX timestamp. Only objects with a startDate greater then this value will be considered. If the current UTC time is greater then provided value, the current time will be used.
endDateQUERYlong(optional) UTC UNIX timestamp. Only objects with an endDate smaller then this value will be considered. Should be greater then current UTC time
minAttendanceQUERYlong(optional) retrieve objects having minimum this attendance capacity. Not all object types support attendance capacity, (default is '0')
maxAttendanceQUERYlong(optional) retrieve objects having maximum this attendance capacity. Not all object types support attendance capacity, (default is '0')
excludedObjectsIdsQUERYString(optional) a comma separated list of object ids to be excluded from the returned objects or from the special feature logic.
includeCompatibilityScoreQUERYboolean(optional) 'true' to retrieve also the rating between the logged in account and the objects (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 objects found base on the filtering parameters (default is 'false' )
objectsSourceQUERYString(optional) specify the source from where the objects to be retrieve base on the provided campaign (default is 0). (0 - only from the provided campaign, 1 - only objects from children campaigns, 2 - from both the provided campaign and children campaign)
orderByQUERYString(optional) specify a sort order.(0 - object type, 1 - by start date, 2 - name, 3 - location, 4 - max attendance, 5 - id, 6 - updated date, 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)
startIndexQUERYint(optional) retrieve objects starting from the provided index, (default is '0')
maxResultsQUERYint(optional) retrieve only this maximum number of objects, (default is 100)
processAllowScheduleMeetingQUERYboolean(optional) process the information which tells for wach result item if the requester can or not schedule meetings with it

Error Codes

100000 ( Campaign )

An unhandled exception has occured.

100002 ( Campaign )

No campaign found for the provided identifier

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

100018 ( Campaign )

The provided special feature is not supported by this endpoint.

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="campaignObjects">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="totalResults" type="xs:int" minOccurs="0"/>
        <xs:element name="object" nillable="true" minOccurs="0" maxOccurs="unbounded">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="accountId" type="xs:long" minOccurs="0"/>
              <xs:element name="objectId" type="xs:long"/>
              <xs:element name="campaignId" type="xs:long" minOccurs="0"/>
              <xs:element name="parentObjectId" type="xs:long" minOccurs="0"/>
              <xs:element name="name" type="xs:string"/>
              <xs:element name="description" type="xs:string" minOccurs="0"/>
              <xs:element name="objectType" type="xs:string"/>
              <xs:element name="objectTypeId" type="xs:long"/>
              <xs:element name="referenceNo" type="xs:string" minOccurs="0"/>
              <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
              <xs:element name="collectedCount" type="xs:long" minOccurs="0"/>
              <xs:element name="numComments" type="xs:long" minOccurs="0"/>
              <xs:element name="startDate" type="xs:dateTime" minOccurs="0"/>
              <xs:element name="endDate" type="xs:dateTime" minOccurs="0"/>
              <xs:element name="timezoneId" type="xs:long" minOccurs="0"/>
              <xs:element name="location" type="xs:string" minOccurs="0"/>
              <xs:element name="notes" type="xs:string" minOccurs="0"/>
              <xs:element name="group" type="xs:string" minOccurs="0"/>
              <xs:element name="displayType" type="xs:string" minOccurs="0"/>
              <xs:element name="position" type="xs:int" minOccurs="0"/>
              <xs:element name="canBeInvitedToMeeting" type="xs:boolean" minOccurs="0"/>
              <xs:element name="openEnrollment" type="xs:boolean" minOccurs="0"/>
              <xs:element name="includeInRegistration" type="xs:boolean" minOccurs="0"/>
              <xs:element name="rating" type="xs:double" minOccurs="0"/>
              <xs:element name="maxAttendance" type="xs:long"/>
              <xs:element name="featureValue" nillable="true" minOccurs="0" maxOccurs="unbounded">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="key" type="xs:string"/>
                    <xs:element name="value" type="xs:string"/>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
              <xs:element name="connection" type="tns:BaseObjectConnection" 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="barcodeUrl" type="xs:anyURI" minOccurs="0"/>
              <xs:element name="survey" type="tns:MatchedSurvey" minOccurs="0"/>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </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="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:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<campaignObjects xmlns="http://xsd.poken.com">
  <object>
    <objectId>25940273</objectId>
    <name>monicatest</name>
    <objectType>Conference Session</objectType>
    <collectedCount>3</collectedCount>
  </object>
  <object>
    <objectId>24938270</objectId>
    <name>product test</name>
    <objectType>Product</objectType>
    <collectedCount>1</collectedCount>
  </object>
</campaignObjects>