Arlo

REST Pub API: Presenters

The Presenters collection resource can be used to retrieve the public details of presenters, including their name, public profile details and social network information. This resource is read-only.

The endpoint supports access the the details of presenters with public information only, and not all event presenters on a platform have a public (promoted) profile.

This resource can return a collection of all available presenters (useful for producing navigation lists), or the details of a specific presenter instance (useful for retrieving data when generating a specific presenter page). The specification of both is covered in this article.

Presenter instance resource

Provides access to individual presenter instances by ID. Skip to an an example request.

Resource URI

/{platform_name}/api/2012-02-01/pub/resources/presenters/{id}

General structure

{
   "PresenterID":10569,
   "FullName":"Danny Foxworth",
   "Profile":{
      "ProfessionalProfile":{
         "ContentType":"application/xhtml",
         "Text":"<p>Carl is the owner-operator of he own consultancy practice Smart People Limited, specialising in the application of the Bridge criteria for performance excellence.</p>\r\n<p>Carl's credentials include:</p>\r\n<ul>\r\n<li>25 years CEO experience in New Zealand and Australia</li>\r\n<li>10 years experience in coaching and consulting to leading New Zealand & Australia businesses</li>\r\n<li>Comprehensive and long term real life experience of the sharp end of the business.</li>\r\n<li>Leading a New Zealand business to finalist status in the New Zealand Quality Foundation Awards programme</li>\r\n<li>Extensive international benchmarking experience Professional public speaker</li>\r\n<li>Broad experience accross product and service industries, local and national government functions and not-for-profits.</li>\r\n</ul>"
      },
      "Qualifications":{
         "ContentType":"application/xhtml",
         "Text":"<ul>\r\n<li>Bachelor of Science (Sc), Waikatio University 1982</li>\r\n<li>Thomas Writing award 2003</li>\r\n</ul>"
      }
   },
   "SocialNetworkInfo":{
      "TwitterID":"DemoPresenter",
      "FacebookID":"DemoPresenter",
      "LinkedInID":"DemoPresenter"
   },
   "ViewUri":"http://acme.example.org/presenters/10569-danny-foxworth"
}

Item fields

Field Description
PresenterID An integer value that uniquely identifies this resource within the platform.
FullName A string representing the name of the full name of the presenter (first and last name), up to 128 characters long.
FirstName A string representing the first name of the presenter, up to 64 characters long.
LastName A string representing the last name of the presenter, up to 64 characters long.
ViewUri String representing a URI containing information about the presenter such as their profile. This field is present only if a URL with additional information is available.
Profile A Profile structure containing promotional information about the presenter such as a professional profile, qualifications and interest information. This field is only present if public profile information is available.
SocialNetworkInfo A SocialNetworkInfo structure containing social network references for the presenter such as Twitter, Facebook, Google+ and LinkedIn details. This field is only present if public social network information is available.

Profile fields

Field Description
ProfessionalProfile A structure containing marked-up text representing the professional profile for this presenter. This field is only present if professional profile information is available. This field is often not suitable for display in lists and can contain arbitrary HTML including tables, lists and images.
Structure fields
  • ContentType: String representing the content type of the information, usually application/xhtml.
  • Text: Text content of the information.
Qualifications A structure containing marked-up text representing the qualifications information for this presenter. This field is only present if qualifications information is available. This field is often not suitable for display in lists and can contain arbitrary HTML including tables, lists and images.
Structure fields
  • ContentType: String representing the content type of the information, usually application/xhtml.
  • Text: Text content of the information.
Interests A structure containing marked-up text representing the interests information for this presenter. This field is only present if interests information is available. This field is often not suitable for display in lists and can contain arbitrary HTML including tables, lists and images.
Structure fields
  • ContentType: String representing the content type of the information, usually application/xhtml.
  • Text: Text content of the information.

SocialNetworkInfo fields

Field Description
TwitterID A string representing the given TwitterID. The field is only present, when the given value is not empty.
FacebookID A string representing the given FacebookID. The field is only present, when the given value is not empty.
LinkedInID A string representing the given LinkedInID. The field is only present, when the given value is not empty.
GooglePlusID A string representing the given GooglePlusID. The field is only present, when the given value is not empty.

HTTP GET

Returns a representation of an individual presenter by ID, including the properties above.

Optional parameters
Parameter Description
format String representing the required response format. Only required if an Accept HTTP header is not provided. Supported values: json

NOTE: If this parameter is missing and no valid Accept header is supplied, the API will return a 406 Not Acceptable response.
callback The script function to call with response data if this call is to be executed as a jsonp request. The HTTP content type for the response will be application/javascript.
fields A list of comma-separated values representing the required fields in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is PresenterID,FullName,ViewUri
Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

Example

Retrieve the details for a presenter with ID 8942, including their full name, profile, social network information and URL to a page with more information.

GET /demo/api/2012-02-01/pub/resources/presenters/8942/?format=json&fields=FullName,Profile,SocialNetworkInfo,ViewUri

{
   "FullName":"John Miller",
   "Profile":{      
      "Qualifications":{
         "ContentType":"application/xhtml",
         "Text":"<ul>\r\n<li>Bachelor of Science (Sc), Waikatio University 1982</li>\r\n<li>Thomas Writing award 2003</li>\r\n</ul>"
      }
   },
   "SocialNetworkInfo":{
      "TwitterID":"JohnMiller99342",
      "FacebookID":"5533234235",
      "LinkedInID":"JohnMillerAU"
   },
   "ViewUri":"http://acme.example.org/presenters/8942-john-miller"
}

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Presenters collection resource

Retrieves a list of presenter instances for all available presenters in the platform. Skip to an example request.

Resource URI

/{platform_name}/api/2012-02-01/pub/resources/presenters/

General structure

This resource returns a collection entity with a StartIndex, Count and Items collection containing presenter instances.

{
   "StartIndex":0,
   "Count":20,
   "Items":[
      {
         "FullName":"Nathan Taft",
         "ViewUri":"http://acme.example.org/presenters/10555-nathan-taft"
      },
      {
         "FullName":"Eric Hailey",
         "ViewUri":"http://acme.example.org/presenters/10556-eric-hailey"
      },
      {
         "FullName":"Sonya Dunn",
         "ViewUri":"http://acme.example.org/presenters/10557-sonya-dunn"
      },
      {
         "FullName":"Danny DeVito",
         "ViewUri":"http://acme.example.org/presenters/10558-danny-devito"
      },
      {
         "FullName":"Ruby Chamblee",
         "ViewUri":"http://acme.example.org/presenters/10560-ruby-chamblee"
      },
      ...
   ]
}

Collection fields

Field Description
StartIndex The start index of the first item in the payload within the overall result set. Used for paging.
Count The number of items returned in the payload in the Items array. This value is different to the total number of results in the overall result set (the TotalCount field). Used in paging and represents the page size.
TotalCount The total number of results in the overall result set. This field is not included unless explicitly requested in the optional parameters.
Items An array of presenter instance records.

HTTP GET

Returns a collection of all presenters, including the properties above.

Optional parameters
Parameter Description
format String representing the required response format. Only required if an Accept HTTP header is not provided. Supported values: json

NOTE: If this parameter is missing and no valid Accept header is supplied, the API will return a 406 Not Acceptable response.
callback The script function to call with response data if this call is to be executed as a jsonp request. The HTTP content type for the response will be application/javascript.
fields A list of comma-separated values representing the required fields for each record in the response payload. Supported values (field names) are listed in the item fields section. Field names are not case sensitive. Default is PresenterID,FullName,ViewUri
skip The number of records to skip in the source results before returning the response payload. Used for paging. Default is 0.
top The maximum number of records to return in the response payload. Used for paging. Default is 20. The maximum supported value is 200.
includeTotalCount Boolean value determining whether an additional property (TotalCount) is included in the response respresenting the total count of matching records on the server, independent of the count of records actually returned in the response payload. Used for paging. Supported values: true, false. Default is false.
region String representing the region to use when retrieving presenter information.

Used only in platforms that have multiple regions installed. This value influences which presenters are returned — only presenters with profiles promoted in the specified region will be included.

Supported values are dependent on regions installed on the platform. If not specified, the default region for the platform will be used when evaluating the request.
Response

See HTTP response codes and error handling for more information on the possible responses and codes returned by this resource.

Example

Retrieve a collection with details of all presenters, including their name and URI link.

GET /demo/api/2012-02-01/pub/resources/presenters/?format=json&fields=FullName,ViewUri

HTTP POST

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.