PRIME Webcast Show Creation OpCode C: Create or Copy a new PRIME Webcast

This opcode is used to create either a new, empty PRIME Webcast or copy an existing PRIME Webcast. It can also be used to create a new PRIME Webcast based on a template.

Note: The Webcast Start Date/Time, if supplied, must be specified in the following 24-hour format: YYYY-MM-DD HH:MI:SS

Example: 2009-12-31 14:30:00

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!50564&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList=C&OutputFormat={X|H|T(default)}&{Additional, opcode-specific parameters in name=value format…}

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!50564. All other parameters may appear in any sequence order.

API Parameter	Type/Size	Req.	Comment
APIUserAuthCode	Varchar 80	Y	Your API authorization code as supplied by Notified.
APIUserCredentials	Varchar 80	Y	Your API user credentials as supplied by Notified.
OpCodeList	Varchar 2000	Y	Must include C to invoke this function.
OutputFormat	Char 1	N	T for text, H for HTTP URL-encoded, or X for XML. Defaults to T.
CreateMode	Integer	Y	The mode in which to create the webcast, where: 0 – Create new, blank 1 – Create a new webcast by copying an existing webcast 2 – Create a new webcast based on a template
SystemUserKey	Integer	Y	The owner key to create this webcast on behalf of.
FromShowKey	Integer	N	If CreateMode is zero (0), then this can be omitted or passed as zero. If CreateMode is one (1), then this is the ShowKey to copy from. If CreateMode is two (2), then this is the Template ShowKey to inherit from.
Title	Varchar 128	Y	The title of the new webcast. Note that in the case of duplicate entries, this title will be decorated [“Webcast (1)”].
ExternalID	Varchar 255	N	Optional External ID or identifier for reporting and tie-back purposes.
WebcastStartDateTime	Varchar 30	N	Beginning date/time of the webcast. Must be in YYYY-MM-DD HH:MI:SS format.

Return Outputs

This API returns the status message OK and the following values upon successful completion.

Column	Type/Size
ShowKey	Integer
EventKey	Integer
AttendeeShowPackageKey	Integer
ShowTitle	Varchar 128
ExternalID	Varchar 255

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0

## OpCode=C Status=0 Message=OK

ShowKey,EventKey,AttendeeShowPackageKey,ShowTitle,ExternalID

123456,93939,46332,My New Webcast,993TX83

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0&OpCode=C&Status=0&Message=OK& ShowKey=123456&EventKey=93939&AttendeeShowPackageKey=46332&ShowTitle=My New Webcast&ExternalID=993TX83

XML

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

<ShowTitle>My New Webcast</ShowTitle>

</ResultRow>

</OpCodeResult>

</APIResults>

Potential Error Codes

Error	Message	Reason
10	Invalid User Key Specified!	The value passed for SystemUserKey is blank or the person is not valid in the tenant identified by the API Credentials.
11	Invalid Title Specified!	The Title may not be blank and must be specified.
12	Invalid Create Mode Specified!	The CreateMode parameter was missing or invalid.
13	Invalid Copy From Show Key Specified!	The CreateMode was passed as one (1), but the FromShowKey is either invalid or not valid in the tenant identified by the API Credentials.
10	Invalid User Key Specified!	The value passed for SystemUserKey is blank or the person is not valid in the tenant identified by the API Credentials.