Users

Action Method URI
List Users GET /user
Get User GET /user/member/{id}
Create User POST /user
Update User PUT /user/member/{id}
Delete User DELETE /user/{id}

List Users

These following parameters are available for listing User objects.

Parameter Details Default
user_page Page number of records 1
limit Number of records to return 25
terms Optional, search terms

Request

GET /user

Response

[
   {
      "id":369915,
      "first_name":"Eric",
      "last_name":"Olson",
      "current_state":"admin",
      "employee":{
         "id":307166,
         "position":"CEO & President",
         "organization":"Zerista"
      },
      "updated_on":"2013-11-05T21:11:59.370404Z",
      "profile": {
          "custom_data": {  
             "project_1":{  
                "focus_area":"Computers"
             }
          } 
      },
      "tags":[
         {
            "id":75105,
            "tag_name":"Additional Filters>Strategy"
         },
         {
            "id":81303,
            "tag_name":"Attendee Type>Event Coordinator"
         }
         {
            "id":78639,
            "tag_name":"Vendor / Distributor"
         }
      ],
      "content":"    <p><strong>About Zerista</strong><br />
        <br />
        Zerista's award-winning event app powers Customer Centric Events for conferences, tradeshows and corporate meetings. Zerista is the first event app to pair an attendee app with a revenue-focused marketing tool set. The result is an app that wows attendees and pays for itself every time.<br />
        <br />
        Powering hundreds of meetings and events around the world, Zerista is backed by a team of experienced marketers and event professionals who support our software. Zerista is the most complete event app on the market, featuring modern app technologies like:<br />
        <br />
        * Content-focused \"Activity Feed\" mobile interface<br />
        * Gamification<br />
        * Multi-event apps<br />
        * Targeted sponsorship marketing<br />
        * Full white label mobile apps (iOS, Android, HTML5) and web apps for lap tops and desktops<br />
        * 1:1 meetings<br />
        * Smart recommendations<br />
        * Build in lead retrieval & lead generation<br />
        * 130+ \"ready now\" integrations<br />
        <br />
        <strong>About Eric</strong><br />
        <br />
        A meetings and events industry thought leader and proven software executive with a penchant for driving growth in entrepreneurial environments.
        <br />
        <br />
        I'm a frequent speaker at industry events on topics including audience generation, gathering intelligence, sponsorship strategy, exhibitor sales, marketing measurement, and hybrid events.<br />
        <br />
        Prior to joining Zerista, I managed the P&L of ACTIVE Network's SMB technology business through a 5-year high growth period, expanding revenue more than 300% while helping more than 9,000 corporates, associations and PCOs create more successful events.
        <br />
        <br />
        Prior to ACTIVE, I drove the marketing and product management side of an education and e-learning start up, growing that business from <$5 million annually to more than $125 million -- including more than $30 million a year in event sales.<br />
        <br />
    </p>",
      "icon_id":314952,
      "client_ids":[
         "303951",
         "000194807I"
      ],
      "phones":[

      ],
      "web_links":{
         "blog":"http://www.zerista.com/News",
         "linkedin":"http://www.linkedin.com/ericolsonmarketing",
         "twitter":"http://twitter.com/eric_ols",
         "website":"http://www.zerista.com"
      },
      "addresses":[
         {
            "street":null,
            "street2":null,
            "city":"Denver",
            "state":"CO",
            "postal_code":"80202",
            "country_code":"US",
            "country_name":"United States"
         }
      ]
   }
]

Top

Get User

You can request a single user via a GET request.  To specify the user to retrieve please refer to Identifying Objects.

Parameter Details Default
id ID of the user 1

Request

GET /user/member/{id}
GET /user/member?user[mapbuzz_auth_attributes][email]={email}

The response body will be the same format as the GET response above but for the current user instead of an array of users.

Top

Create User

You can create users via a POST request using the user parameters specified below.  Upon successful completion of a POST request you will receive either a 200 or 203 http response code.  A 203 response means that the user is already part of Zerista database (from another Zerista supported conference) and was successfully added to your conference (the details you pass do not apply to the user yet).  None of the existing user information is updated.  To update an existing user please see the Update User section below. So upon receiving 203 HTTP response back, please make an another request (PUT).

Request

POST /user

The response body will be the same format as the GET response above but for the current user instead of an array of users.

Top

Update User

You can update a user via a PUT request using the user parameters specified below.  All fields included in an update request will be updated to the given value.

To specify the user to update please refer to Identifying Objects.

Request

PUT /user/member/{id}

The response body will be the same format as the GET response above but for the current user instead of an array of users.

Top

Delete User

You can remove a user from a conference via a DELETE request.  Note that this does NOT delete the user from Zerista, it just removes the user from the current conference.

To specify the user to delete please refer to Identifying Objects.

Request

DELETE /user/member/{id}

A successful  response will not include a body.

Top

User Parameters

General Information

The following parameters are used when creating or updating users.

Parameter Example Details
user[salutation] Mr. Optional, maximum 20 characters
user[first_name] Rufus Required, maximum 64 characters
user[last_name] Kanarowski Required, maximum 64 characters
user[membership] speaker Optional. Values: ‘member’, ‘moderator’, ‘speaker’, ‘exhibitor’, ‘press’, ‘rejected’. Default value: member
user[mapbuzz_auth_attributes][email] rufus@zerista.com Required
user[mapbuzz_auth_attributes][password] mySecretPassword NOT recommended for general use – please talk to your account manager before using this parameter

Employment Information

Setting the employment information will make the user appear in the “Employees” section on the page for the exhibitor with the given company name. This differs from an “exhibitor contact” in that the exhibitor contacts have editing privileges for the exhibitor. Also, setting a company name for a user, does not mean that an exhibitor will be created.

Parameter Example Details
user[employee_attributes][position] CEO Optional
user[employee_attributes][company_attributes][name] Zerista Optional*

* If you specify a position, the company name is required.

Photo

You may include a URI to a photo for a user. The file must be available at the time of the request for Zerista to download and store the image. The photo may be in the following formats: GIF, JPEG, or PNG.

Parameter Example Details
user[item_attributes][icon_uri] http://www.exmple.com/my-exhibitor/logo.gif Optional

Tags

Tags are a comma-separated list of words and phrases that are used when users search for users. Zerista also uses tags to identify sets of users for custom functionality.

Parameter Example Details
user[item_attributes][tags_list] social networking, conferences, communities Optional

Addresses

Passing an address is optional. If an address is being passed, the required fields that constitute a valid address are city, state, and country code.

Note: If the country code being passed is NOT US or CA (Canada), state field becomes optional.

Here are the available parameters:

Parameter Example Details
user[account_attributes][addresses_attributes][0][street] 1721 Gilpin St. Optional
user[account_attributes][addresses_attributes][0][street2] Suite 200 Optional
user[account_attributes][addresses_attributes][0][postal_code] 80121 Optional
user[account_attributes][addresses_attributes][0][city] Denver Required
user[account_attributes][addresses_attributes][0][state] CO Required (if country code is US or CA)
user[account_attributes][addresses_attributes][0][country_code] US Required, 2-char code**

** see http://www.iso.org/iso/country_codes.htm

You may add additional addresses by augmenting the index like so:

user[account_attributes][addresses_attributes][0][street]
user[account_attributes][addresses_attributes][1][street]

Phone Numbers

Parameter Example Details
user[item_attributes][phones_attributes][0][work_number] 393-333-3333 Optional
user[item_attributes][phones_attributes][0][cell_number] 393-333-3333 Optional
user[item_attributes][phones_attributes][0][fax_number] 393-333-3333 Optional

Bio

Parameter Example Details
user[item_attributes][article_attributes][content] Sandrine is interested in social networking. Optional*
user[item_attributes][remove_article] 1 Optional. Passing a value of 1 will remove the biographical information from the user.

* Biographical information must be well-formed XHTML.

Web Links

Parameter Example Details
user[account_attributes][web_links][blog] http://blog.zerista.com/ Optional
user[account_attributes][web_links][linkedin] http://www.linkedin.com/company/zerista-inc Optional
user[account_attributes][web_links] http://www.facebook.com/Zerista Optional
user[account_attributes][web_links][website] http://www.zerista.com Optional
user[account_attributes][web_links][twitter] http://www.twitter.com/ZeristaSoftware Optional
user[account_attributes][web_links]
  • An error has occurred; the feed is probably down. Try again later.
http://blog.zerista.com/feed Optional

Custom Data

You can use the custom data field to attach any data that doesn’t fit into the fields above. Note that this field accepts only a stringified JSON object as show in parameters below:

Parameter Example Details
user[account_attributes][profiles_attributes][0][custom_data] “{\”project_1\”:{\”focus_area\”:\”Computers\”}}” A string with valid JSON content

Account Preferences

You may add additional preferences by augmenting the index like so:

user[account_attributes][preferences_attributes][0][key]
user[account_attributes][preferences_attributes][0][value]
user[account_attributes][preferences_attributes][1][key]
user[account_attributes][preferences_attributes][1][value]
Parameter Example Details
user[account_attributes][preferences_attributes][0][key] Virtual Required
user[account_attributes][preferences_attributes][0][value] 1 (for true), 0 (for false) Required

News Feed Support

The user api supports returning users via the Atom Response format.

<?xml version="1.0" encoding="utf-8" ?>
<entry xmlns="http://www.w3.org/2005/Atom"
       xmlns:atom="http://www.w3.org/2005/Atom">
  <id>http://example.zerista.com/user/122</id>
  <link rel="self" type="application/atom+xml"
        href="http://example.zerista.com/profile/member?account_id=213" />
  <link rel="alternate" type="text/html"
        href="http://example.zerista.com/profile/member?account_id=213" />
  <title>Sandrine</title>
  <updated>2009-07-28T11:10:54-06:00</updated>
  <content type="application/xml">
    <person xmlns="http://ns.opensocial.org/2008/opensocial">
      <id>http://example.zerista.com/user/122</id>
      <displayName>Sandrine</displayName>
    </person>
  </content>
</entry>

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s