Join Campaign

Description

Joins a campaign by providing the unique campaign code. In the future, for 'Public' campaigns we'll support joining a campaign providing an id

HTTP Method

POST

Path

/campaign/join

Authentication

Requires an authenticated user.

Parameters

Table 11.  Parameters for " Join Campaign "

NameTypeValue TypeDescription
codeFORMStringthe campaign registration code. You can't join a campaign if is a 'Private' campaign

Error Codes

100000 ( Campaign )

An unhandled exception has occured.

100002 ( Campaign )

No campaign found for the provided identifier

100004 ( Campaign )

The campaign doesn't exist or is inactive

100006 ( Campaign )

The campaign doesn't support joining by code

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="campaign">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseCampaign">
          <xs:sequence>
            <xs:element name="statistics" type="tns:CampaignStats" minOccurs="0"/>
            <xs:element name="objectTypesPrivacy" type="tns:ObjectTypesPrivacy" minOccurs="0"/>
            <xs:element name="objectTypesStats" type="tns:ObjectTypesStats" minOccurs="0"/>
            <xs:element name="campaignCustomSettings" type="tns:CampaignCustomSettings" minOccurs="0"/>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:element name="campaignDetails">
    <xs:complexType>
      <xs:complexContent>
        <xs:extension base="tns:BaseCampaign">
          <xs:sequence>
            <xs:element name="statistics" type="tns:CampaignStats" minOccurs="0"/>
            <xs:element name="objectTypesStats" type="tns:ObjectTypesStats" minOccurs="0"/>
            <xs:element name="permissions">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="owners" type="xs:long"/>
                  <xs:element name="editors" type="xs:long"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
            <xs:element name="badgeSettings">
              <xs:complexType>
                <xs:sequence>
                  <xs:element name="showCmpInfo" type="xs:boolean" minOccurs="0"/>
                  <xs:element name="showPokenInstr" type="xs:boolean" minOccurs="0"/>
                  <xs:element name="eventDetailTitle" type="xs:string" minOccurs="0"/>
                  <xs:element name="eventDetailDesc" type="xs:string" minOccurs="0"/>
                  <xs:element name="eventDetailsImage" type="xs:anyURI" minOccurs="0"/>
                  <xs:element name="frontDesignType" type="xs:int" minOccurs="0"/>
                  <xs:element name="frontHdrBgColor" type="xs:string" minOccurs="0"/>
                  <xs:element name="frontHdrTextColor" type="xs:string" minOccurs="0"/>
                  <xs:element name="frontBanner" type="xs:anyURI" minOccurs="0"/>
                  <xs:element name="frontSponsorImage" type="xs:anyURI" minOccurs="0"/>
                  <xs:element name="printCategoryFullPath" type="xs:boolean" minOccurs="0"/>
                  <xs:element name="backDesignType" type="xs:int" minOccurs="0"/>
                  <xs:element name="backSponsorImage" type="xs:anyURI" minOccurs="0"/>
                  <xs:element name="printAttendeeBarCode" type="xs:boolean" minOccurs="0"/>
                  <xs:element name="printAttendeeQRCode" type="xs:boolean" minOccurs="0"/>
                </xs:sequence>
              </xs:complexType>
            </xs:element>
          </xs:sequence>
        </xs:extension>
      </xs:complexContent>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="BaseCampaign">
    <xs:sequence>
      <xs:element name="campaignId" type="xs:long"/>
      <xs:element name="accountId" type="xs:long"/>
      <xs:element name="campaign" type="xs:string"/>
      <xs:element name="campaignType" type="xs:string"/>
      <xs:element name="campaignPrivacyType" type="xs:string"/>
      <xs:element name="parentCampaignId" type="xs:long" minOccurs="0"/>
      <xs:element name="parentCampaignName" type="xs:string" minOccurs="0"/>
      <xs:element name="timezoneId" type="xs:long"/>
      <xs:element name="languageId" type="xs:long"/>
      <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="deviceRedirect" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="deviceCSS" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="cardColorHead" type="xs:string" minOccurs="0"/>
      <xs:element name="cardColorText" type="xs:string" minOccurs="0"/>
      <xs:element name="cardBackground" type="xs:string" minOccurs="0"/>
      <xs:element name="bannerLink" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="innerBannerLink" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="banner" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="innerBanner" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="mobileBanner" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="bannerType" type="xs:string" minOccurs="0"/>
      <xs:element name="showOnWidget" type="xs:boolean" minOccurs="0"/>
      <xs:element name="startDate" type="xs:date" minOccurs="0"/>
      <xs:element name="endDate" type="xs:date" minOccurs="0"/>
      <xs:element name="status" type="xs:string" minOccurs="0"/>
      <xs:element name="deviceAutoIdentity" type="xs:long" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="deviceTag" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="thumbnail" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="contentURL" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="nbPurchasedDevices" type="xs:long"/>
      <xs:element name="visitorListPrivacy" type="xs:string" minOccurs="0"/>
      <xs:element name="showFileWidget" type="xs:boolean" minOccurs="0"/>
      <xs:element name="shareInfoComments" type="xs:string" minOccurs="0"/>
      <xs:element name="referenceNumberRegularExpression" type="xs:string" minOccurs="0"/>
      <xs:element name="termsAndConditions" type="xs:string" minOccurs="0"/>
      <xs:element name="attendeesMustAcceptEventTerms2Register" type="xs:boolean" minOccurs="0"/>
      <xs:element name="acceptanceStatement" type="xs:string" minOccurs="0"/>
      <xs:element name="attendeesMustAcceptPokenTerms2Register" type="xs:boolean" minOccurs="0"/>
      <xs:element name="brandedBackground" type="xs:anyURI" minOccurs="0"/>
      <xs:element name="brandedBackgroundRepeat" type="xs:string" minOccurs="0"/>
      <xs:element name="brandedBackgroundColor" type="xs:string" minOccurs="0"/>
      <xs:element name="eventInfo" type="tns:EventInfo" minOccurs="0"/>
      <xs:element name="defaultPassword" type="xs:string" minOccurs="0"/>
      <xs:element name="passwordSetupType" type="xs:string"/>
      <xs:element name="promptSignupSetPhoto" type="xs:string" minOccurs="0"/>
      <xs:element name="promptSignupLinkPoken" type="xs:string" minOccurs="0"/>
      <xs:element name="registrationInfo" type="tns:RegistrationInfo" minOccurs="0"/>
      <xs:element name="allowPokensToAutoLogin" type="xs:boolean" minOccurs="0"/>
      <xs:element name="nfcBadgeEnabled" type="xs:boolean" minOccurs="0"/>
      <xs:element name="lastChangedDate" type="xs:dateTime" minOccurs="0"/>
      <xs:element name="downloadEventAdditional" type="xs:boolean" minOccurs="0"/>
      <xs:element name="downloadEventGallery" type="xs:boolean" minOccurs="0"/>
      <xs:element name="downloadEventFiles" type="xs:boolean" minOccurs="0"/>
      <xs:element name="attendeeRefIdUnique" type="xs:boolean" minOccurs="0"/>
      <xs:element name="exhibitorRefIdUnique" type="xs:boolean" minOccurs="0"/>
      <xs:element name="objectRefIdUnique" type="xs:boolean" minOccurs="0"/>
      <xs:element name="mhBranding" type="tns:MhBranding" minOccurs="0"/>
      <xs:element name="mmhBranding" type="tns:MmhBranding" minOccurs="0"/>
      <xs:element name="newMH" type="xs:boolean" minOccurs="0"/>
      <xs:element name="defaultMeetingDurationSeconds" type="xs:int"/>
      <xs:element name="allowAttendeesChangeMeetingDuration" type="xs:boolean" minOccurs="0"/>
      <xs:element name="attendeeMeetingLocationTypes" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="exhibitorMeetingLocationTypes" type="xs:string" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="meetingsSchedulingTimeIncrementSeconds" type="xs:int"/>
      <xs:element name="meetingStartTimeSpecifiedType" type="xs:string" minOccurs="0"/>
      <xs:element name="meetingEndTimeSpecifiedType" type="xs:string" minOccurs="0"/>
      <xs:element name="allowVisitorMeetingScheduling" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowVisitor2VisitorMeetingScheduling" type="xs:boolean" minOccurs="0"/>
      <xs:element name="attendeeMaxNbMeetings" type="xs:long" minOccurs="0"/>
      <xs:element name="attendeeTargetNbMeetings" type="xs:long" minOccurs="0"/>
      <xs:element name="attendeeMaxNbMeetingGuests" type="xs:long" minOccurs="0"/>
      <xs:element name="attendeeMeetingLocationRequired" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowAttendeesTentativeMeetingAnswer" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowExhibitorsRequestMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowExhibitorsScheduleMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowExhibitorsSendMessages" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowAttendeesRequestMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowAttendeesScheduleMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowAttendeesSendMessages" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowExhibitorsScheduleOpenMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="allowAttendeesScheduleOpenMeetings" type="xs:boolean" minOccurs="0"/>
      <xs:element name="exhibitorMaxNbMeetingRequests" type="xs:long" minOccurs="0"/>
      <xs:element name="attendeeMaxNbMeetingRequests" type="xs:long" minOccurs="0"/>
      <xs:element name="meetingScheduleAvailability" 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="CampaignStats">
    <xs:sequence>
      <xs:element name="participants" type="xs:long"/>
      <xs:element name="objects" type="xs:long"/>
      <xs:element name="devices" type="xs:long"/>
      <xs:element name="activeDevices" type="xs:long"/>
      <xs:element name="meetingsOpenEnrollment" type="xs:long"/>
      <xs:element name="sessionsOpenEnrollment" type="xs:long"/>
      <xs:element name="sessionsInRegistration" type="xs:long"/>
      <xs:element name="surveyQuestionsInRegistration" type="xs:long"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="ObjectTypesPrivacy">
    <xs:sequence>
      <xs:element name="privacy" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="objectTypeId" type="xs:long"/>
            <xs:element name="showToAll" type="xs:boolean" minOccurs="0"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="ObjectTypesStats">
    <xs:sequence>
      <xs:element name="objectTypeStat" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="objectTypeId" type="xs:long"/>
            <xs:element name="count" type="xs:long"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CampaignCustomSettings">
    <xs:sequence>
      <xs:element name="mhCustomSettings" type="xs:string" 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:complexType name="MhBranding">
    <xs:sequence>
      <xs:element name="primaryColor" type="xs:string"/>
      <xs:element name="secondaryColor" type="xs:string"/>
      <xs:element name="backgroundColor" type="xs:string"/>
      <xs:element name="signinImage" type="xs:anyURI"/>
      <xs:element name="primaryTagline" type="xs:string" minOccurs="0"/>
      <xs:element name="secondaryTagline" type="xs:string" minOccurs="0"/>
      <xs:element name="displaySyncPokenPanel" type="xs:boolean" minOccurs="0"/>
      <xs:element name="showSupportMenu" type="xs:boolean" minOccurs="0"/>
      <xs:element name="showBuyMenu" type="xs:boolean" minOccurs="0"/>
      <xs:element name="customMenus" type="tns:CustomMenus" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="CustomMenus">
    <xs:sequence>
      <xs:element name="menu" nillable="true" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="text" type="xs:string"/>
            <xs:element name="title" type="xs:string" minOccurs="0"/>
            <xs:element name="link" type="xs:anyURI"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="MmhBranding">
    <xs:sequence>
      <xs:element name="campaignAcronym" type="xs:string"/>
      <xs:element name="primaryColor" type="xs:string"/>
      <xs:element name="secondaryColor" type="xs:string"/>
      <xs:element name="backgroundColor" type="xs:string"/>
      <xs:element name="logo" type="xs:anyURI"/>
      <xs:element name="signinImage" type="xs:anyURI"/>
      <xs:element name="primaryTagline" type="xs:string" minOccurs="0"/>
      <xs:element name="secondaryTagline" type="xs:string" minOccurs="0"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="CampaignType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Master"/>
      <xs:enumeration value="Standard"/>
      <xs:enumeration value="Exhibitor"/>
      <xs:enumeration value="Basic"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="CampaignPrivacyType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="PRIVATE_EVENT"/>
      <xs:enumeration value="SEMI_PUBLIC_EVENT"/>
      <xs:enumeration value="PUBLIC_EVENT"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="BannerType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="IMAGE"/>
      <xs:enumeration value="FLASH"/>
      <xs:enumeration value="TEXT"/>
      <xs:enumeration value="JAVASCRIPT"/>
      <xs:enumeration value="IFRAME"/>
    </xs:restriction>
  </xs:simpleType>

  <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="VisitorListPrivacy">
    <xs:restriction base="xs:string">
      <xs:enumeration value="COMPLETE_LIST"/>
      <xs:enumeration value="ONLY_COLLECTED"/>
      <xs:enumeration value="NO_LIST"/>
    </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:simpleType name="ObjectLocationTypes">
    <xs:restriction base="xs:string">
      <xs:enumeration value="ANYWHERE"/>
      <xs:enumeration value="AT_EXHIBITOR_LOCATION"/>
      <xs:enumeration value="AT_PREDEFINED_PLACES"/>
    </xs:restriction>
  </xs:simpleType>

  <xs:simpleType name="MeetingTimeSpecifiedEnum">
    <xs:restriction base="xs:string">
      <xs:enumeration value="MULTIPLES_OF_DEFAULT_MEETING_DURATION"/>
      <xs:enumeration value="MULTIPLES_OF_STANDARD_TIME_INCREMENT"/>
      <xs:enumeration value="ANY_TIME"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<campaign xmlns="http://xsd.poken.com">
		<campaignID>1300602</campaignID>
		<campaign>Poken USA</campaign>
		<organization>POken USA</organization>
		<address1>Street1</address1>
		<address2></address2>
		<city>A City</city>
		<zip>32323</zip>
		<state>CA</state>
		<country>US</country>
		<latitude>32.32323</latitude>
		<longitude>32.32323</longitude>
		<defaultPassword>poken</defaultPassword>
		<passwordSetupType>useDefault</passwordSetupType>
		<deviceCSS>http://www.poken.com/campaign/poken/device.css
		</deviceCSS>
		<cardColorHead>#FFFFFF</cardColorHead>
		<cardColorText>#515151</cardColorText>
		<cardBackground>http://cache-user.poken.com/images/bg_cards-default-card.png
		</cardBackground>
		<bannerLink>http://www.poken.com</bannerLink>
		<banner>http://cache-static.poken.com/custom/poken/banner.jpg
		</banner>
		<bannerType>IMAGE</bannerType>
		<thumbnail>http://wwww.poken.com/media-export/event/1300602/thumbnail
		</thumbnail>
		<contentURL>http://www.poken.com/about</contentURL>
		<description>just a test event</description>
		<showOnWidget>true</showOnWidget>
		<widgetTitle>Test title in widget</widgetTitle>
		<widgetDate>from 1st to 3th March 2010</widgetDate>
		<hostedBy>Poken Usa, San Francisco</hostedBy>
		<pinIcon>http://wwww.poken.com/media-export/event/1300602/icon</pinIcon>
		<startDate>2009-06-01+03:00</startDate>
		<endDate>2109-06-01+03:00</endDate>
		<deviceAutoIdentity>123456</deviceAutoIdentity>
        <deviceTag>tag1</deviceTag>
        <deviceTag>tag2</deviceTag>
        <showFileWidget>true</showFileWidget>
</campaign>