Q. Collateral
The Collateral API allows access to “Green Collateral” associated with Users, Events, and Exhibitors.
| Action | Method | URI |
|---|---|---|
| List object’s Collateral | GET | /green/{object-id}?type={object-type}&klass=all |
| List Collateral in User’s library | GET | /green/library?type={object-type} |
| Get Collateral Details or Embedding code | GET | /green/member/{id} |
| Add Collateral to object | POST | /green/{object-id}?type={object-type} |
| Delete Collateral | DELETE | /green/member/{id} |
Listing Collateral
You can list the collateral of an object by it’s ID (in the URI path) and it’s type
| Parameter | Details | Default |
|---|---|---|
| type | Type of the object-id: user, event, exhibitor | N/A |
| page | Page number of records | 1 |
| limit | Number of records to return | 20 |
| klass | The klass of collateral objects to return. You should specify all |
document |
Adding Collateral
You can add collateral to an object by it’s ID (in the URI path) and it’s type.
| Parameter | Example | Details |
|---|---|---|
| type | exhibitor | Required, One of exhibitor, user, event |
| name | My Picture | Required, descriptive name of the collateral |
| klass | link | Required, See below for full list of types |
| value | http://www.zerista.com | Required, See below for allowed values per type |
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 |
JSON Response Example
TBD
XML Response Example
TBD
