Show Planner Opcode A: Add an item to the Show Planner

This OpCode is used to add an item (typically an event/webcast) to the specified person’s Show Planner in the VTS system. If the specified item already exists in the show planner, its settings are updated. The user specifications may be made using either the email address or External ID. When using the email address, either omit or set LookupByExternalID to zero (0). When this is set to one (1), the user is located using the External ID. Planner Items are specified either by their description or by their code (event code). When using the description, either omit or set EntityCode to empty (‘’). When using the code, either omit or set EntityDescription to empty (‘’).

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.

Show Planner AP:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50530&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&OpCodeList={Opcode[OpCode[…]]}&OutputFormat={X|H|T(default)}&LookupByExternalUserID={0(default)|1}&{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!50520 for the Buddy List API and LASCmd=AI:4;F:APIUTILS!50530 for the Show Planner API. All other parameters may appear in any sequence.

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 20	Y	Should include A to invoke this function.
OutputFormat	Char 1	N	T for text, H for HTTP URL-encoded, or X for XML. Defaults to T.
EMailAddress	Varchar 255	Y/N	Email address for the person whose buddy list is being accessed. If blank, ExternalID must be used and LookupByExternalID must be set to one (1).
LookupByExternalUserID	Bit (0/1)	N	Pass one (1) to look up this person by the supplied ExternalID (your internal identifier). If omitted or zero (0), the EMailAddress field is used to look up this person.
ExternalID	Varchar 255	-	Your internal identifier for this person. This value must be unique for each person.
ShowKey	Integer	Y	The show key to use to retrieve additional details, such as current location, online status.
EntityType	Integer	N	Entity type enumerator for the type of item being added to the planner. For Events/Webcasts, this value should be set to 1 (default).
EntityCode	Varchar 255	N	Pass this code value to look up the entity based on its code, rather than description.
NotifyLeadTime	Integer (0-5)	N	Lead time to notify a person that this event is starting. Valid values are: 0=none, 1=1hr, 2 =30min, 3=15min, 4=10min, 5=5min.
NotifyMethod	Integer (0-3)	N	Method to use when notifying a person that this event is going to start. Valid values are: 0=none, 1=email, 2=popup message, 3=both.

Return Outputs

This API does not return any additional results.

Text

### APICallResult=0 APICallDiagnostic=OK OpCodesProcessed=1 OpCodesInError=0
## OpCode=A Status=0 Message=OK

HTTP URL-encoded

APICallResult=0&APICallDiagnostic=OK&OpCodesProcessed=1& OpCodesInError=0& OpCode=A&Status=0&Message=OK

XML

<?xml version="1.0" encoding="windows-1252" ?>
<APIResults APICallResult="0" APICallDiagnostic="OK" OpCodesProcessed="1" OpCodesInError=”0” >
<OpCodeResult OpCode="A" Status="0" Message="OK" >
</OpCodeResult>
</APIResults>

Potential Error Codes

Error	Message	Reason
10	Invalid or Missing Entity Specified	The value passed in either EntityDescription or EntityCode does not match with an entity in the system.
11	Invalid Notify Lead Time Specified	NotifyLeadTime must be in the range of 0-5.
12	Invalid Notify Method Specified	NotifyMethod must be in the range of 0-3.