Show Node

This node represents a show and any registration values within the platform for the specified user.

Calling the API

The API is called via a secure HTTPS request. This HTTPS request may be a GET or POST operation. Each request must supply the authentication credentials assigned to the caller by Notified. Only requests with valid credentials will be processed. These credentials identify the caller and provide access only to a specific customer area.

The format of the call is: https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50569&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OutputFormat={X|J(default)}&LookupByExternalUserID={0(default)|1}&ExternalUserID={User ID to lookup if LookupByExternalID=1}&EMailAddress={Email address of user to lookup if LookupByExternalID omitted or zero}&LiveStartDate={optional filter for live run date in MM/DD/YYYY format}&LiveOnly={1/0 (default) filter to limit display}&TimeZoneInfoKey={optional time zone specifier to convert dates/times for display. Default is UTC}

Note: The format of the APAC Data Center is: https://api.apac.onlinexperiences.com.

Specific parameter ordering is unimportant, with the only restriction being that the first parameter MUST BE LASCmd=AI:4;F:APIUTILS!50569. All other parameters may appear in any sequence order.

Example:

XML:

<?xml version="1.0" encoding="utf-8"?>

<APIStatus Code="0" Diag="OK" /><Shows><Show ShowKey="1234" Title="Wednesday Broadcast" RegDate="2012-05-29 13:27:33" UniqueUserID="D5B292CB-99B3-4840-A257-B61C2442F477

"><Dates><Date DateType="Live" FromDateTime="2012-05-29 14:00:00" ToDateTime="2012-05-29 14:30:00"/><Date DateType="OnDemand" FromDateTime="2012-05-29 14:30:00" ToDateTime="2013-05-29 14:30:00"/></Dates></Show></Shows>

JSON:

{"APIStatus":0,"Diag":"OK","Shows":[{"ShowKey":"1234","Title":"Wednesday Broadcast","RegDate":"2012-05-29 13:27:33.000","UniqueUserID":"D5B292CB-99B3-4840-A257-B61C2442F477","Dates":[{"DateType":"Live","FromDateTime":"2012-05-29 14:00:00.000","ToDateTime":"2012-05-29 14:30:00.000"},{"DateType":"OnDemand","FromDateTime":"2012-05-29 14:30:00.000","ToDateTime":"2013-05-29 14:30:00.000"}]}]}