Exhibitors

Action Method URI
List Exhibitors And Sponsors GET /exhibitor
List Exhibitors GET /exhibitor/exhibitor
List Sponsors GET /exhibitor/sponsor
Get Exhibitor or Sponsor GET /exhibitor/member/{id}
Create Exhibitor POST /exhibitor
Update Exhibitor PUT /exhibitor/member/{id}
Delete Exhibitor DELETE /exhibitor/member/{id}
List Sponsorships GET /admin/sponsorship
List Exhibitor Contacts GET /exhibitor_role/account?state=contact
Add Exhibitor Contact POST /exhibitor_role/account?state=contact
Remove Exhibitor Contact POST /exhibitor_role/account?state=contact

List Exhibitors And Sponsors

Parameter Details Default
exhibitor_page Page number of records 1
limit Number of records to return 50

Request

GET /exhibitor

View Sample Response

Top

List Exhibitors

The same query parameters mentioned in List Exhibitors And Sponsors section are also applicable here.
Top

List Sponsors

The same query parameters mentioned in List Exhibitors And Sponsors section are also applicable here.
Top

Get Exhibitor or Sponsor

Parameter Details Default
id ID of the exhibitor 1

Request

GET /exhibitor/member/{id}

View Sample Response

Top

Create Exhibitor

You can create exhibitors via a POST request using the exhibitor parameters specified below. Upon successful completion of a POST request you will receive a 200 http response code. To update an existing exhibitor please see the Update Exhibitor section below.

Request

POST /exhibitor

Response

The response body will be the same format as the sample response below but for the newly created exhibitor instead of an array of exhibitors.
Top

Update Exhibitor

You can update an exhibitor via a PUT request using the exhibitor parameters specified below. All fields included in an update request will be updated to the given value. Upon successful completion of a PUT request you will receive a 200 http response code.
To specify the exhibitor to update please refer to Identifying Objects.

Request

PUT /exhibitor/member/{id}

Response

The response body will be the same format as the sample response below but for the updated exhibitor instead of an array of exhibitors.
Top

Delete Exhibitor

You can delete an exhibitor via a DELETE request. To specify the exhibitor to delete please refer to Identifying Objects.
Upon successful completion of a DELETE request you will receive a 200 http response code.

Request

DELETE /exhibitor/member/{id}

Top

Sponsorships

Request

GET /admin/sponsorship

Response

[
   {
      "id":1151,
      "name":"Platinum",
      "position":1
   },
   {
      "id":1152,
      "name":"Gold",
      "position":2
   },
   {
      "id":1153,
      "name":"Silver",
      "position":3
   },
   {
      "id":1154,
      "name":"Bronze",
      "position":4
   }
]

Top

Exhibitor Parameters

Parameter Example Details
exhibitor[company_attributes][name] Zerista, Inc. Required
exhibitor[description] description Optional, XHTML*
exhibitor[sponsorship_name] Gold Sponsor Optional
exhibitor[sponsor] true Optional, default is false
exhibitor[exhibitor] false Optional, default is true
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

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] 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]
  • An error has occurred; the feed is probably down. Try again later.
http://blog.zerista.com/feed Optional

Exhibitor’s Address

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[item_attributes][icon_uri] http://www.exmple.com/my-exhibitor/logo.gif 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
exhibitor[account_attributes][profiles_attributes][0][custom_data] “{\”project_1\”:{\”focus_area\”:\”Computers\”}}” A string with valid JSON content

Request Content Types

Request content types can be form url encoded data (application/x-www-form-urlencoded) or JSON (application/json). To input data as JSON make sure to set the content type request header to ‘application/json’. With a JSON request since they are no post parameters (the JSON input is set as form body), the request signing algorithm can ignore the post_params. Below is a sample JSON request body:

Sample JSON Request

{  
   "client_id":"123456", 
   "exhibitor":{  
      "company_attributes":{           
         "name":"Zerista, Inc."
      },
      "description":"My company Description",
      "sponsorship_name":"Platinum",
      "sponsor":true,
      "exhibitor":true,
      "item_attributes":{  
         "phones_attributes":{  
            "0":{  
               "work_number":"393-333-3333",
               "cell_number":"393-333-3333",
               "fax_number":"393-333-3333"
            }
         },
         "tags_list":"Tag A, Tag B",
         "icon_uri":"https://www.google.com/images/srpr/logo11w.png"
      },
      "booth_attributes":{  
         "0":{  
            "booth_name":"Booth 419",
            "building_name":"Hall C"
         },
         "1":{  
            "booth_name":"Booth 420"
         }
      },
      "contacts":{  
         "0":"sam@mapbuzz.com"
      },
      "account_attributes":{  
         "web_links":{  
            "website":"http://somewebsite",
            "facebook":"http://facebook/test"
         },
         "addresses_attributes":{  
            "0":{  
               "street":"17th Street",
               "street2":"Suite 123",
               "city":"Denver",
               "state":"CO",
               "postal_code":"80201",
               "country_code":"US"
            }
         }
      }
   }
}

Sample JSON Response

{  
   "id":62012,
   "sponsorship_id":1151,
   "sponsorship_name":"Platinum",
   "exhibitor":true,
   "sponsor":true,
   "name":"Zerista",
   "updated_on":"2013-10-31T16:26:03.036851Z",
   "tags":[  
      {  
         "id":81145,
         "tag_name":"Event Consulting"
      },
      {  
         "id":81143,
         "tag_name":"Event Lead Generation"
      },
      {  
         "id":36825,
         "tag_name":"Event Marketing"
      },
      {  
         "id":81144,
         "tag_name":"Mobile Event Apps"
      }
   ],
   "content":" 
Build & Manage Your Digital Ecosystem 

",
   "sort_value":"Zerista",
   "phones":[  
      {  
         "work_number":"(720)230-6801",
         "cell_number":"",
         "fax_number":""
      }
   ],
   "icon_id":369260,
   "client_ids":[  

   ],
   "profile": {
       "custom_data": {  
          "project_1":{  
             "focus_area":"Computers"
          }
       } 
   },
   "web_links":{  
      "facebook":"https://www.facebook.com/Zerista",
      "linkedin":"https://www.linkedin.com/company/zerista-inc.",
      "rss":"http://zerista.com/feed/",
      "twitter":"https://twitter.com/Zerista",
      "website":"http://zerista.com/"
   },
   "addresses":[  
      {  
         "street":"1740 Platte Street",
         "street2":null,
         "city":"Denver",
         "state":"CO",
         "postal_code":"80202",
         "country_code":"US",
         "country_name":"United States"
      }
   ],
   "booths":[  
      {  
         "id":866884,
         "building_name":null,
         "booth_name":"Booth 39 & 40"
      }
   ],
   "contacts":[  
      {  
         "exhibitor_id":62012,
         "user_id":400765
      },
      {  
         "exhibitor_id":62012,
         "user_id":400766
      }
   ]
}
]

Top

List Exhibitor Contacts

Parameter Details Default
exhibitor_id / exhibitor_client_id Exhibitor identifier id or client id of an exhibitor

Request

GET /exhibitor_role/account?state=contact

Response

If the request was successful, response JSON will include the user information (Sample JSON here: https://dev.zerista.com/users/)
Top

Add Exhibitor Contact

Parameter Details Default
exhibitor_id or exhibitor_client_id Exhibitor identifier id or client id of an exhibitor
user_id or user_client_id User identifier id or client id of a user that will be added as exhibitor contact

Request

POST /exhibitor_role/account?state=contact

Response

If the request was successful, response JSON will include the user information (Sample JSON here: https://dev.zerista.com/users/)
Top

Remove Exhibitor Contact

Parameter Details Default
exhibitor_id or exhibitor_client_id Exhibitor identifier id or client id of an exhibitor
user_id or user_client_id User identifier id or client id of a user that will be removed as exhibitor contact

Request

DELETE /exhibitor_role/account?state=contact

Response

If the request was successful, response JSON will include the user information (Sample JSON here: https://dev.zerista.com/users/)

Top

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