Collateral

The Collateral API allows access to “Green Collateral” associated with Users, Events, and Exhibitors.

Action Method URI
List User Collateral GET /green/user/{id}
List Exhibitor Collateral GET /green/exhibitor/{id}
List Event Collateral GET /green/event/{id}
List Poster Collateral GET /green/poster/{id}
Get Collateral Details or Embedding code GET /green/member/id
Add User Collateral POST /green/user/{id}
Add Exhibitor Collateral POST /green/exhibitor/{id}
Add Event Collateral POST /green/event/{id}
Add Poster Collateral POST /green/poster/{id}
Delete Collateral DELETE /green/member/id

List User Collateral

Request

GET /green/user/{id}
Parameter Details Default
page Page number of records 1
limit Number of records to return 20

Top

List Exhibitor Collateral

Request

GET /green/exhibitor/{id}
Parameter Details Default
page Page number of records 1
limit Number of records to return 20

Top

List Event Collateral

Request

GET /green/event/{id}
Parameter Details Default
page Page number of records 1
limit Number of records to return 20

Top

List Poster Collateral

Request

GET /green/poster/{id}
Parameter Details Default
page Page number of records 1
limit Number of records to return 20

Top

Add User Collateral

POST /green/user/{id}
Parameter Example Details
collateral[name] My Picture Required, descriptive name of the collateral
type link Required, See below for full list of types
collateral[value] http://www.zerista.com Required, See below for allowed values per type
collateral[thumbnail] Thumbnail Image URL Optional, Thumbnail image URL for the collateral

Top

Add Exhibitor Collateral

POST /green/exhibitor/{id}
Parameter Example Details
collateral[name] My Picture Required, descriptive name of the collateral
type link Required, See below for full list of types
collateral[value] http://www.zerista.com Required, See below for allowed values per type
collateral[thumbnail] Thumbnail Image URL Optional, Thumbnail image URL for the collateral

Top

Add Event Collateral

POST /green/event/{id}
Parameter Example Details
collateral[name] My Picture Required, descriptive name of the collateral
type link Required, See below for full list of types
collateral[value] http://www.zerista.com Required, See below for allowed values per type
collateral[thumbnail] Thumbnail Image URL Optional, Thumbnail image URL for the collateral

Top

Add Poster Collateral

POST /green/poster/{id}
Parameter Example Details
collateral[name] My Picture Required, descriptive name of the collateral
type link Required, See below for full list of types
collateral[value] http://www.zerista.com Required, See below for allowed values per type
collateral[thumbnail] Thumbnail Image URL Optional, Thumbnail image URL for the collateral

Top

Collateral Types and Values

Type Value
link URI to be displayed from a popup (target=_blank) link
raw strictly valid HTML to be displayed in a modal javascript popup
iframe URI to a web page to be displayed in a modal javascript popup
flash strictly valid HTML <object> code, or a URI to an SWF file, to be displayed in a modal javascript popup
audio URI to an MP3 file to be displayed in a modal javascript popup with our Flash MP3 player
sonic_foundry URI to a SonicFoundry embed to be displayed in a modal javascript popup
flickr URI to a Flickr slideshow to be displayed in a modal javascript popup
youtube URI to a Youtube video to be displayed in a modal javascript popup
document URI to a document file, available for at least 24 hours from the time of the API request, that is one of the following types: PDF, Plain Text, CSV, MS Word, MS Excel, MS PowerPoint, MS PowerPoint Slideshow. The file may not exceed 5 MiB
image URI to an image file, available for at least 24 hours from the time of the API request, that is one of the following types: JPEG, GIF, PNG. The file may not exceed 5 MiB

Top

JSON Response Example

[
   {
      "id":931577418,
      "name":"Kashmir",
      "media_type":"Audio",
      "mime_type":"video/mpeg",
      "uri":"http://green-energy-2008.zerista.l.dm7.me/files_user/attachments/7/kashmir.mp3",
      "value":"/files_user/attachments/7/kashmir.mp3",
      "type":"audio",
      "thumbnail":null,
      "item":{
         "id":661003508,
         "type":"event"
      }
   },
   {
      "id":666997558,
      "name":"North Fork of the Flathead River",
      "media_type":"Image",
      "mime_type":"image/jpeg",
      "uri":"http://green-energy-2008.zerista.l.dm7.me/files_user/attachments/6/prd_040385.jpg",
      "value":"/files_user/attachments/6/prd_040385.jpg",
      "type":"image",
      "thumbnail":"http://green-energy-2008.zerista.l.dm7.me/files_user/attachments/6/prd_040385.jpg",
      "item":{
         "id":661003508,
         "type":"event"
      }
   }
]