Commands Listing
:: Project Windstone ::
Current Protocol Version: 00.96
Last Revised: 2005-09-16
Programmer: SoundWave (soundwave@nkpcorp.com)
[ Class :: Setup Transactions ]
0000 :: SETUP_INITIALIZE
Description: Initial setup, agent now online, requesting registration.
Supplied Data: Software identifier, software type ("PC-Based" or "Web-Based"), command landing URL, URL to redirect logins to.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
0001 :: SETUP_ERROR
Description: Registration error occured, review error message.
Supplied Data: Error message.
Secure Transaction: No Reserved for Windstone Server Only: Yes Available for Use: Yes
0002 :: SETUP_COMPLETE
Description: Registration successful, save following data. Administrator must use activation key provided in their Windstone control panel to activate and associate the agent system.
Supplied Data: Unique agent identifier, primary authentication token, secondary authentication token, activation key, security code, shared encryption key (255 random characters, non-binary), registration completion date and time (epoch).
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
[ Class :: User Transactions ]
1100 :: USER_LOGIN_NORM
Description: Request for user login session ID, will authenticate by saved user authentication token.
Supplied Data: Primary authentication token, secondary authentication token, Email address of user.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
1101 :: USER_LOGIN_NEW
Description: Request for user login session ID, new user to system, will save user authentication token.
Supplied Data: Primary authentication token, secondary authentication token, Email address of user.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
1102 :: USER_LOGIN_REDIRECT
Description: Request to redirect user to the following URL for user to enter their password. Remember given transaction ID, will be used to provide authentication status.
Supplied Data: User Email address, URL.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1103 :: USER_LOGIN_PROCEED
Description: Request for PC-Based software to proceed with authentication process. Remember transaction number, will be used to provide authentication status.
Supplied Data: User Email address.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1104 :: USER_AUTH_CHECK
Description: Authentication complete, check given user authentication token against saved token on agent system.
Supplied Data: User authentication token.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1105 :: USER_AUTH_SAVE
Description: Authentication complete, save user authentication token for future login reference.
Supplied Data: User authentication token, display name of user.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1106 :: USER_AUTH_DENIED
Description: Authentication complete, user is denied authentication by Windstone for security reasons. Check denial reason to decide further action.
Supplied Data: Denial reason ("SUSPEND", "MINOR ALARM", "MAJOR ALARM", "REVOKED", "BAD", "PENDING"), denial message.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1107 :: USER_INFO
Description: Request for a user's public information profile.
Supplied Data: Primary authentication token, secondary authentication token, Email address of user.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
1108 :: USER_PROFILE
Description: Public user profile.
Supplied Data: Email address, display name, user "About Me" text, last login date and time, account created date and time, online status.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
1109 :: USER_LOGIN_DATA
Description: Login information to complete PC-based login authentication.
Supplied Data: Primary authentication token, secondary authentication token, login session ID, user password.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
[ Class :: Agent Transactions ]
2200 :: AGENT_HEARTBEAT
Description: Request for any unprocessed data pending download by an agent system (such as messages, etc.).
Supplied Data: Primary authentication token, secondary authentication token.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
2201 :: AGENT_INFO
Description: Request for public agent profile.
Supplied Data: Primary authentication token, secondary authentication token, requested agent identifier.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
2202 :: AGENT_PROFILE
Description: Public agent profile.
Supplied Data: Agent identifier, software name, software type, display name, landing URL, last registered IP address.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
2203 :: AGENT_AUTH_DENIED
Description: Authentication has expired for security reasons, no commands will be processed or sent until authentication is refreshed.
Supplied Data: X
Secure Transaction: No Reserved for Windstone Server Only: Yes Available for Use: Yes
2204 :: AGENT_AUTH_REBID
Description: Requesting reauthentication using security code and current primary and secondary authentication tokens.
Supplied Data: Primary authentication token, secondary authentication token, security code.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
2205 :: AGENT_AUTH_SUCCESS
Description: Reauthentication successful, save the following data.
Supplied Data: New primary authentication token, new secondary authentication token.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
2206 :: AGENT_ERROR
Description: Error message from last transaction.
Supplied Data: Error message.
Secure Transaction: No Reserved for Windstone Server Only: Yes Available for Use: Yes
[ Class :: Message Transactions ]
3300 :: MSG_ID_NEW
Description: Request for new message identification number.
Supplied Data: Primary authentication token, secondary authentication token, message type ("User-to-User", "User-to-Agent", "Agent-to-Agent", "Agent-to-User"), sender Email address or agent identifier, recipient Email address or agent identifier.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
3301 :: MSG_ID_DATA
Description: Message ID created, remember following data for message update.
Supplied Data: Sender Email address or agent identifier, message identification number.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
3302 :: MSG_ID_DENIED
Description: Request for creation of new message denied.
Supplied Data: Error message.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes
3303 :: MSG_SAVE
Description: Request to update message with message data and release it for delivery.
Supplied Data: Message identification number, subject, message text.
Secure Transaction: Yes Reserved for Windstone Server Only: No Available for Use: Yes
3304 :: MSG_DATA
Description: New message for user or agent.
Supplied Data: Message identification number, message type ("User-to-User", "User-to-Agent", "Agent-to-Agent", "Agent-to-User", "System"), sender, recipient, subject, message text, created date and time.
Secure Transaction: Yes Reserved for Windstone Server Only: Yes Available for Use: Yes