GamePlay Node
GamePlay Node
This node contains information about a gameplay session.
Example:
<GamePlay GameKey="15569" Title="WordScramble" TeamKey="17" TeamName="Raptors" FromDate="2006-09-06 15:50:10" ToDate="2006-09-06 15:53:41" Points="27" />
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!50566&APIUserAuthCode={YourAuthCode}&APIUserCredentials={YourCredentials}&ShowKey={ShowKey}&FromDateTime={FromDate in YYYY-MM-DD HH:MM:SS format}&ToDateTime={ToDate in YYYY-MM-DD HH:MM:SS format}&ActivityTypeFilter={filter code list, in |OPTION|OPTION| format…}&FilterUserType={0|1|-1 where 0 = attendees, 1 = exhibitors, -1 = both}
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!50566. All other parameters may appear in any sequence order.
Attribute |
Type |
Comment |
---|---|---|
GameKey |
Integer |
The Notified game key of the game that the entry relates to. |
Title |
String |
The title of the game that the entry relates to. |
TeamKey |
Integer |
Team key of the team that the person was playing for, else 0, indicating an individual play. |
TeamName |
String |
Name of the team that the person was playing for. |
FromDate |
Date |
Date and time that the gameplay started. |
ToDate |
Date |
Date and time that the gameplay ended. |
Points |
Integer |
The number of points earned in the gameplay session. |