Buddy List Opcode L: List the Users in the Buddy List

This OpCode is used to list out the users that belong to the specified person’s buddy list in the VTS system. 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. When this is set to one (1), the user is located using the External ID.

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.

Buddy List API:

https://api.onlinexperiences.com/scripts/Server.nxp?LASCmd=AI:4;F:APIUTILS!50520&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 L 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.
BuddyEMailAddress	Varchar 255	Y/N	Email address for the person who is to be added to the buddy list. If blank, BuddyExternalID must be used and BuddyLookupByExternalID must be set to one (1).
BuddyLookupByExternalUserID	Bit (0/1)	N	Pass one (1) to look up this person by the supplied BuddyExternalID (your internal identifier). If omitted or zero (0), the BuddyEMailAddress field is used to look up this person.
BuddyExternalID	Varchar 255	N	Your internal identifier for this person. This value must be unique for each person.
ShowKey	Integer	N	The show key to use to retrieve additional details, such as current location, online status.
OnlineOnly	Bit (0/1)	N	Pass one (1) to filter the list to only show buddies that are currently logged in to the show specified by ShowKey.

Return Outputs

This API returns a result set of buddy list information upon successful completion. The result set is structured as follows:

Column	Type/Size
BuddyUserName	Varchar 80
BuddyEMailAddress	Varchar 255
BuddyCompanyName	Varchar 80
EmoticonImage	Varchar 300
IsOnline	Integer (0/1)
CurrentLocationDesc	Varchar 500
BuddyUserKey	Integer
BuddyUserType	Integer (0/1)
NotifyOnLogin	Integer (0/1)
IsBuddyRegisteredForShow	Integer (0/1)

Potential Error Codes

There are no potential error codes for this API call.