Last Update: 2019-10-02

Get events

Request:

<getevents>
  <status></status>
</getevents>
Description of XML-Tags:
Element Format Description
getevents->status Comma-separated
0|1|2|3|4
Optional
0..Draft, 1..Active/Open, 3..Active/Save-the-date, 4..Active/Closed, 2..Archive (Default=1)

Response:

<events>
  <event id="">
    <language></language>
    <title></title>
    <opener></opener>
    <custom1></custom1>
    ...
    <custom5></custom5>
    <link></link>
    <dates>
      <date id="">
        <datetime></datetime>
        <datetimetill></datetimetill>
        <title></title>
        <description></description>
        <location></location>
        <invited></invited>
        <subscribed max=""></subscribed>
        <waitinglist max=""></waitinglist>
        <refused></refused>
        <participated></participated>
      </date>
      ...
    </dates>
  </event>
  ...
</events>
Description of XML-Tags:
Element Format Description
events List of all events
events->event Container element of one event
events->event["id"] int(10) ID of event
events->event->language char(2) 2-letter code of event language
events->event->title varchar(255) Title of event
events->event->opener text Teaser text of event
events->event->custom1-5 text Optional; Custom field 1-5 of event
events->event->link varchar(255) Unpersonalized URL to event landingpage for subscription
events->event->dates List of all event dates
events->event->dates->date Container element of one event-date
events->event->dates->date->datetime YYYY-mm-dd HH:ii:ss Date and time of date
events->event->dates->date->datetimetill YYYY-mm-dd HH:ii:ss End-Date and time of date
events->event->dates->date->title varchar(255) Title of date
events->event->dates->date->description text Description of date
events->event->dates->date->location varchar(255) Location of date
events->event->dates->date->invited int(10) Number of invited addresses
events->event->dates->date->subscribed int(10) Number of subscribed addresses
events->event->dates->date->subscribed["max"] int(10) Optional; If given the number of maximum subscriptions, otherwise unlimited
events->event->dates->date->waitinglist int(10) Optional; If given the number of addresses on waitinglist, otherwise there is no waitinglist
events->event->dates->date->waitinglist["max"] int(10) Optional; If given the waitinglist-size, otherwise unlimited
events->event->dates->date->refused int(10) Number of refused addresses
events->event->dates->date->participated int(10) Number of participated addresses

Get event statistics

Request:

<geteventstatistics key="Email">
  <datefrom>YYYY-mm-dd</datefrom>
  <datetill>YYYY-mm-dd</datetill>
  <page>1</page>
  <pagesize>1000</pagesize>
</geteventstatistics>
Description of XML-Tags:
Element Format Description
geteventstatistics["key"] varchar(30) Determines which field of each address-record is returned. If "key" is not specified, default-key is email.
geteventstatistics->datefrom YYYY-mm-dd Beginning of the desired date range (date of subscription/unsubscription/invitation of address)
geteventstatistics->datetill YYYY-mm-dd Optional; End of the desired date range (date of subscription/unsubscription/invitation of address). If not specified, the current date will be set.
geteventstatistics->page Optional; Request a specific page of the result-set (Default=1)
geteventstatistics->pagesize Optional; Defines the number of returned records (Default=1000)

Response:

<addresses>
  <address key="Email">
    <eventstatid></eventstatid>
    <addressid></addressid>
    <eventid></eventid>
    <dateid></dateid>
    <status></status>
    <escort></escort>
    <escortname></escortname>
    <subscribedby></subscribedby>
    <subscribedother>
      <address key="user1@domain.com" />
      ...
    </subscribedother>
  </address>
  ...
</addresses>
<events>
  <event id="">
    <title></title>
    <dates>
      <date id="">
        <datetime></datetime>
        <title></title>
      </date>
      ...
    </dates>
  </event>
  ...
</events>
Description of XML-Tags:
Element Format Description
addresses List of all addresses with statistic data of the specified date range
addresses->address Container element of one address
addresses->address["key"] varchar(255) The address identifier; The field which was defined the request addresslistadd->addresses["key"]
addresses->address-eventstatid int(10) ID of the statistic record
addresses->address->addressid int(10) ID of the address; Useful if addresses->address["key"] is empty to fetch the address-record via command <addressget>.
addresses->address->eventid int(10) ID of the event
addresses->address->dateid int(10) ID of the date
addresses->address->status 0..Invited/No response, 1..Subscribed, 2..Waitinglist, 3..Refused, 4..Participated
addresses->address->escort 1|0 Set to "1" if address has company
addresses->address->escortname varchar(255) Optional; Name of the accompanying person
addresses->address->subscribedby key of the address which has subscribed this address
addresses->address->subscribedother List of addresses which are subscribed by this address
addresses->address->subscribedother->address[key] key of address which is subscribed by this address
Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.