Get account campaigns

Description

Retrieves basic campaign information for the logged in account campaigns

HTTP Method

GET

Path

/campaign/@all

Authentication

Requires an authenticated user.

Parameters

Table 8.  Parameters for " Get account campaigns "

NameTypeValue TypeDescription
displayEndedCampaignsQUERYboolean(optional) if 'true' will return also the ended campaigns the logged in user is part of
includeNoBrandingQUERYboolean(optional) if 'true' will return also the campaigns without branding the logged in user is part of. Default is 'false'.
commonToAccountIdQUERYlong(optional) will only return campaigns the logged in account has in common with this account.

Error Codes

100000 ( Campaign )

An unhandled exception has occured.

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="accountCampaigns">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="campaign" type="tns:BasicCampaign" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="BasicCampaign">
    <xs:sequence>
      <xs:element name="campaignId" type="xs:long"/>
      <xs:element name="campaignName" type="xs:string"/>
      <xs:element name="organization" type="xs:string" minOccurs="0"/>
      <xs:element name="address1" type="xs:string" minOccurs="0"/>
      <xs:element name="address2" type="xs:string" minOccurs="0"/>
      <xs:element name="city" type="xs:string" minOccurs="0"/>
      <xs:element name="zip" type="xs:string" minOccurs="0"/>
      <xs:element name="state" type="xs:string" minOccurs="0"/>
      <xs:element name="country" type="xs:string" minOccurs="0"/>
      <xs:element name="latitude" type="xs:string" minOccurs="0"/>
      <xs:element name="longitude" type="xs:string" minOccurs="0"/>
      <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="active" type="xs:boolean" minOccurs="0"/>
      <xs:element name="status" type="xs:string"/>
      <xs:element name="eventInfo" type="tns:EventInfo" minOccurs="0"/>
      <xs:element name="registrationInfo" type="tns:RegistrationInfo" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="EventInfo">
    <xs:sequence>
      <xs:element name="objectId" type="xs:long" minOccurs="0"/>
      <xs:element name="name" type="xs:string" minOccurs="0"/>
      <xs:element name="description" type="xs:string" minOccurs="0"/>
      <xs:element name="scheduled" type="xs:string" minOccurs="0"/>
      <xs:element name="hostedBy" type="xs:string" 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"/>
      <xs:element name="scheduleAvailability" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="timeframe" type="tns:Timeframe" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="Timeframe">
    <xs:sequence>
      <xs:element name="startDate" type="xs:dateTime"/>
      <xs:element name="endDate" type="xs:dateTime"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="RegistrationInfo">
    <xs:sequence>
      <xs:element name="regCompleteMatchmakingSurvey" type="xs:string"/>
      <xs:element name="regScheduleMeetingsWithExhibitors" type="xs:string"/>
      <xs:element name="regScheduleMeetingsWithAttendees" type="xs:string"/>
      <xs:element name="signInUpdateInvalidEmail" type="xs:string"/>
      <xs:element name="signInUpdateTempPass" type="xs:string"/>
      <xs:element name="postSignInAddProfilePhoto" type="xs:string"/>
      <xs:element name="postSignInCompleteMatchmakingSurvey" type="xs:string"/>
      <xs:element name="postSignInScheduleMeetingsWithExhibitors" type="xs:string"/>
      <xs:element name="postSignInScheduleMeetingsWithAttendees" type="xs:string"/>
      <xs:element name="remindUploadEverythingCollected" type="xs:string"/>
      <xs:element name="matchmakingNbTimesAttendeesCanSubmitSurvey" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="CampaignStatus">
    <xs:restriction base="xs:string">
      <xs:enumeration value="ACTIVE"/>
      <xs:enumeration value="ENDED"/>
      <xs:enumeration value="PENDING"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="RegistrationFlowOptions">
    <xs:restriction base="xs:string">
      <xs:enumeration value="REQUIRED"/>
      <xs:enumeration value="OPTIONAL"/>
      <xs:enumeration value="NOT_INCLUDED"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="SubmissionTimesOptions">
    <xs:restriction base="xs:string">
      <xs:enumeration value="ONCE"/>
      <xs:enumeration value="MULTIPLE_TIMES"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<accountCampaigns xmlns="http://xsd.poken.com">
		<campaign>
				<campaignId>1736703</campaignId>
				<campaignName>zTest_event_tigruta</campaignName>
				<address1>pont, 22</address1>
				<address2>
				</address2>
				<city>Lausanne</city>
				<zip>
				</zip>
				<state>
				</state>
				<country>US</country>
				<latitude>46.5210099</latitude>
				<longitude>6.6332518</longitude>
				<active>false</active>
				<defaultPassword>poken</defaultPassword>
				<passwordSetupType>useDefault</passwordSetupType>
				<eventInfo>
						<name>Tigruta</name>
						<description>Bogdan is hosting an event</description>
						<scheduled>between today and tomorrow</scheduled>
						<hostedBy>Bogdan</hostedBy>
						<startDate>2011-12-11+01:00</startDate>
						<endDate>2012-12-06+01:00</endDate>
				</eventInfo>
		</campaign>
</accountCampaigns>