H. Exhibitors
The exhibitors API allows the creation of exhibitors. To load contacts to exhibitors, you must first add them as users (see section C), then you can use the
exhibitor[contacts]
parameters to set them as contacts when you add the exhibitor.
| Action | Method | URI |
|---|---|---|
| List Exhibitors | GET | /exhibitor |
| Get Exhibitor | GET | /exhibitor/member/{id} |
| Create Exhibitor | POST | /exhibitor |
| Update Exhibitor | PUT | /exhibitor/member/{id} |
| Update Exhibitor via client_id | PUT | /exhibitor |
| Delete Exhibitor via client_id | DELETE | /exhibitor |
| List User’s Followed Exhibitors | GET | /role/exhibitors |
| Follow an Exhibitor | POST | /role/exhibitors/{id} |
| Unfollow an Exhibitor | DELETE | /role/exhibitors/{id} |
Listing Exhibitors
These query parameters are available for listing Exhibitor objects (these do not apply to the follow resources).
| Parameter | Details | Default |
|---|---|---|
| exhibitor_page | Page number of records | 1 |
| limit | Number of records to return | 20 |
| exhibitor_sponsor | 0 to return only exhibitors 1 to return only sponsorship ignore to return both exhibitors and sponsors |
0 |
| terms | Optional, search terms |
Updating and Deleting via client_id
When updating or deleting exhibitors via a client_id, you must include the client_id that you created the exhibitor with:
http://example.zerista.com/exhibitor?client_id=1122334455&compan...
All fields included in an update request will be overridden to the given value. The response for updating a exhibitor is the same as creating an exhibitor; however, for deleting an exhibitor, a successful response will not include a body.
Following Exhibitors
When mimicking a user via a token authentication, you may get and update the list of exhibitors that the user is following. When following or unfollowing an exhibitor, use the exhibitor’s ID for the {id} in the URI.
Exhibitor Parameters
| Parameter | Example | Details |
|---|---|---|
| exhibitor[company_attributes][name] | Zerista, Inc. | Required |
| exhibitor[description] | description | Optional, XHTML* |
| exhibitor[sponsorship_name] | Gold Sponsor | Optional |
| client_id | 1122334455 | Optional** |
* Exhibitor descriptions must be well-formed XHTML.
** Providing the client_id is optional; however, you must track the exhbitor IDs, or you will not be able to update/delete the exhibitor without it.
Phone Numbers
You may add additional addresses by augmenting the index like so:
exhibitor[item_attributes][phones_attributes][0][work_number] exhibitor[item_attributes][phones_attributes][1][work_number]
| Parameter | Example | Details |
|---|---|---|
| exhibitor[item_attributes][phones_attributes][0][work_number] | 393-333-3333 | Optional |
| exhibitor[item_attributes][phones_attributes][0][cell_number] | 393-333-3333 | Optional |
| exhibitor[item_attributes][phones_attributes][0][fax_number] | 393-333-3333 | Optional |
Tags
Tags are a comma-separated list of words and phrases that are used when users search for exhibitors.
| Parameter | Example | Details |
|---|---|---|
| exhibitor[item_attributes][tags_list] | social networking, conferences, communities | Optional |
Exhibitor Booths
You may add multiple booths and buildings by augmenting the index like so:
exhibitor[booth_attributes][0][booth_name] exhibitor[booth_attributes][0][building_name] exhibitor[booth_attributes][1][booth_name] exhibitor[booth_attributes][1][building_name]
| Parameter | Example | Details |
|---|---|---|
| exhibitor[booth_attributes][0][booth_name] | Room 5 | Optional |
| exhibitor[booth_attributes][0][building_name] | Hall A | Optional |
Exhibitor Contacts
Exhibitor contacts have the ability to modify the exhibitor, send messages, and send meeting requests on behalf of the exhibitor account. Exhibitor contacts are also listed on the exhibitor’s page under the “Contacts” section. Note that this is distinct from the list of the exhibitor’s employees (see E. Users – Employment Information).
You may add multiple contacts by augmenting the index like so:
exhibitor[contacts][0] exhibitor[contacts][1]
You can clear the exhibitor’s contacts by passing the parameter key
exhibitor[contacts]
with the value
clear
On a DELETE request, you may pass
exhibitor[contacts]=remove
to remove the contacts completely from the conference; however, the request will fail if any of the contacts are speakers in the conference.
| Parameter | Example | Details |
|---|---|---|
| exhibitor[contacts][0] | rufus@zerista.com | Optional* |
| exhibitor[contacts] | clear | Clears all the contacts |
* This must the address of an existing user.
Web Links
| Parameter | Example | Details |
|---|---|---|
| exhibitor[account_attributes][web_links][blog] | http://blog.zerista.com/ | Optional |
| exhibitor[account_attributes][web_links][linkedin] | http://www.linkedin.com/company/zerista-inc | Optional |
| exhibitor[account_attributes][web_links][facebook] | http://www.facebook.com/Zerista | Optional |
| exhibitor[account_attributes][web_links][website] | http://www.zerista.com | Optional |
| exhibitor[account_attributes][web_links][twitter] | http://www.twitter.com/ZeristaSoftware | Optional |
| exhibitor[account_attributes][web_links][myspace] | http://www.myspace.com/Zerista | Optional |
exhibitor[account_attributes][web_links]
|
http://blog.zerista.com/feed | Optional |
Exhibitor’s Address
You may add additional addresses by augmenting the index like so:
exhibitor[account_attributes][addresses_attributes][0][street] exhibitor[account_attributes][addresses_attributes][1][street]
| Parameter | Example | Details |
|---|---|---|
| exhibitor[account_attributes][addresses_attributes][0][street] | 1721 Gilpin St. | Optional* |
| exhibitor[account_attributes][addresses_attributes][0][street2] | Suite 200 | Optional* |
| exhibitor[account_attributes][addresses_attributes][0][city] | Denver | Optional* |
| exhibitor[account_attributes][addresses_attributes][0][postal_code] | 80121 | Optional* |
| exhibitor[account_attributes][addresses_attributes][0][state] | CO | Optional* |
| exhibitor[account_attributes][addresses_attributes][0][country_code] | US | Optional*, 2-char code** |
* Partial addresses are not allowed, if you specify any part of an address, the remainder becomes required (except street2).
** see http://www.iso.org/iso/country_codes.htm
Logos
You may include a URI to a logo for an exhibitor. The file must be available at the time of the request for Zerista to download and store the image. The logo may be in the following formats: GIF, JPEG, or PNG.
| Parameter | Example | Details |
|---|---|---|
| exhibitor[logo_uri] | http://www.exmple.com/my-exhibitor/logo.gif | Optional |
Media
Media is no longer supported through calls to the Exhibitor API. See Collateral.
Atom Response Example
<?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/exhibitor/member/122</id>
<link rel="self" type="application/atom+xml"
href="http://example.zerista.com/exhibitor/member?account_id=213" />
<link rel="alternate" type="text/html"
href="http://example.zerista.com/exhibitor/member?account_id=213" />
<title>Zerista, Inc</title>
<updated>2009-07-28T11:10:54-06:00</updated>
<content type="application/xml">
<organization xmlns="http://ns.opensocial.org/2008/opensocial">
<id>http://example.zerista.com/exhibitor/member/122</id>
<displayName>Zerista, Inc</displayName>
</organization>
</content>
</entry>
JSON Response Example
{
"id": 1,
"exhibitor": true,
"sponsor": true,
"company_name": "Zerista, Inc.",
"sponsorship_name": "MWC Connect",
"item": {
"id": 409,
"display_value": "Zerista, Inc.",
"created_on": {
"n": 0,
"json_class": "Time",
"s": 1230845211
},
"updated_on": {
"n": 0,
"json_class": "Time",
"s": 1230845211
},
"tags": ["<>&'\"", "Denver"],
"icon": {
"id": 1068,
"content_type": "image/png",
"versions": {
"small_hover-32": "icon_1068_32_hover.png",
"photo-640": "icon_1068_640.png",
"medium-64": "icon_1068_64.png",
"extra_large-150": "icon_1068_150.png",
"small-32": "icon_1068_32.png",
"logo-200": "icon_1068_200.png",
"large-100": "icon_1068_100.png"
}
},
"article": {
"id": 261379594,
"item_id": 409,
"content": "<p>Zerista enables event managers to <strong>strengthen relationships</strong> between\ntheir core stakeholders in a <strong>unique</strong> and <strong>compelling</strong>\nway.</p>\n<p>Watch our customer video and hear what they say.</p>\n"
},
"phones": [{
"work_number": "111-222-3333",
"fax_number": "001 - 12323233",
"cell_number": null
}]
},
"account": {
"id": 209,
"account_name": "zerista_green_exhibitor",
"web_links": {
"blog": "http://blog.zerista.com",
"myspace": "http://zerista.myspace.com",
"website": "http://www.zerista.com",
"rss": "http://blog.zerista.com",
"linkedin": "http://zerista.linkedin.com",
"facebook": "http://zerista.facebook.com",
"twitter": "http://twitter.com/ZeristaSoftware",
"email": "sales@zerista.com"
},
"addresses": [{
"street": "Lakewood Heights Dr",
"street2": null,
"city": "Denver",
"state": "CO",
"postal_code": "80215",
"country_code": "US",
"country_name": "United States"
}]
},
"booths": [{
"building_name": "Hall A",
"booth_name": "Booth 411"
}],
"contacts": [{
"user_id": 8,
"first_name": "<selenium>",
"last_name": "<test user>",
"display_name": "<selenium>"
}]
}
XML Response Example
<?xml version="1.0" encoding="UTF-8"?>
<exhibitor>
<id type="integer">1</id>
<exhibitor type="boolean">true</exhibitor>
<sponsor type="boolean">true</sponsor>
<company-name>Zerista, Inc.</company-name>
<sponsorship-name>MWC Connect</sponsorship-name>
<item>
<id type="integer">409</id>
<display-value>Zerista, Inc.</display-value>
<created-on type="datetime">2009-01-01T21:26:51Z</created-on>
<updated-on type="datetime">2009-01-01T21:26:51Z</updated-on>
<tags type="array">
<tag>Social Networking</tag>
<tag>Denver</tag>
</tags>
<icon>
<id type="integer">1068</id>
<content-type>image/png</content-type>
<versions>
<small-hover-32>icon_1068_32_hover.png</small-hover-32>
<photo-640>icon_1068_640.png</photo-640>
<extra-large-150>icon_1068_150.png</extra-large-150>
<medium-64>icon_1068_64.png</medium-64>
<small-32>icon_1068_32.png</small-32>
<logo-200>icon_1068_200.png</logo-200>
<large-100>icon_1068_100.png</large-100>
</versions>
</icon>
<article>
<id type="integer">261379594</id>
<item-id type="integer">409</item-id>
<content><p>Zerista enables event managers to <strong>strengthen relationships</strong> between
their core stakeholders in a <strong>unique</strong> and <strong>compelling</strong>
way.</p>
<p>Watch our customer video and hear what they say.</p>
</content>
</article>
<phones type="array">
<phone>
<work-number>111-222-3333</work-number>
<fax-number>001 - 12323233</fax-number>
<cell-number nil="true"></cell-number>
</phone>
</phones>
</item>
<account>
<id type="integer">209</id>
<account-name>zerista_green_exhibitor</account-name>
<web-links>
<blog>http://blog.zerista.com</blog>
<myspace>http://zerista.myspace.com</myspace>
<email>sales@zerista.com</email>
<rss>http://blog.zerista.com</rss>
<facebook>http://zerista.facebook.com</facebook>
<website>http://www.zerista.com</website>
<linkedin>http://zerista.linkedin.com</linkedin>
<twitter>http://twitter.com/ZeristaSoftware</twitter>
</web-links>
<addresses type="array">
<address>
<street>Lakewood Heights Dr</street>
<street2 nil="true"></street2>
<city>Denver</city>
<state>CO</state>
<postal-code>80215</postal-code>
<country-code>US</country-code>
<country-name>United States</country-name>
</address>
</addresses>
</account>
<booths type="array">
<booth>
<building-name>Hall A</building-name>
<booth-name>Booth 411</booth-name>
</booth>
</booths>
<contacts>
<contacts type="array">
<contact>
<user-id type="integer">8</user-id>
<first-name>Charlie</first-name>
<last-name>Savage</last-name>
<display-name>Charlie Savage</display-name>
</contact>
</contacts>
</contacts>
</exhibitor>
