GamesByEmail.com Web Services

GamesByEmail.com makes web services available to developers. These web services are provided without warranty.

Also, some GamesByEmail icons are available. If you need them in a different size or format, let me know.

There are currently two types available, SOAP and JavaScript. The parameters and returned objects are similar.

My Turns
JavaScript Url: http://WebServices.GamesByEmail.com/JavaScript/MyTurns
SOAP Url: http://WebServices.GamesByEmail.com/Soap/Service?op=GetTurns

Parameter Description

UserId (Required) The email address or GamesByEmail id of the user or email address.

Password (Required) The user's password, encrypted or unencrypted.

VendorAndVersion (Optional) A vendor and version identifier used to uniquely identify your application. Used to determine if an upgrade is recommended. Use the GamesByEmail's comments form to request that a upgradePage be set for a particular VendorAndVersion string.

Function (Optional) Name of a function to call with return object as first parameter. If not supplied, just the return object is defined. This is only used with the JavaScript version.

Parameter	Description
UserId	(Required) The email address or GamesByEmail id of the user or email address.
Password	(Required) The user's password, encrypted or unencrypted.
VendorAndVersion	(Optional) A vendor and version identifier used to uniquely identify your application. Used to determine if an upgrade is recommended. Use the GamesByEmail's comments form to request that a upgradePage be set for a particular VendorAndVersion string.
Function	(Optional) Name of a function to call with return object as first parameter. If not supplied, just the return object is defined. This is only used with the JavaScript version.

Properties of returned object:

Property Description

turns An array of objects with game titles and urls.

playAllUrl A url to play all games.

status 0 OK, 2 invalid credentials.

interval The recommended time to wait (in seconds) before checking again. Please use this each time instead of a constant interval so I can tweak notifiers depending on server load, or set to several hours during a maintenence period.

message Some sort of message if there was a problem.

upgradePage Based on the VendorAndVersion string, you can recommend that players upgrade their notifier. Let GamesByEmail know what VendorAndVersion values you recommend upgrades for. GamesByEmail will set the upgradePage, and your application can check it for length>0 and handle how ever needed.

Property	Description
turns	An array of objects with game titles and urls.
playAllUrl	A url to play all games.
status	0 OK, 2 invalid credentials.
interval	The recommended time to wait (in seconds) before checking again. Please use this each time instead of a constant interval so I can tweak notifiers depending on server load, or set to several hours during a maintenence period.
message	Some sort of message if there was a problem.
upgradePage	Based on the VendorAndVersion string, you can recommend that players upgrade their notifier. Let GamesByEmail know what VendorAndVersion values you recommend upgrades for. GamesByEmail will set the upgradePage, and your application can check it for length>0 and handle how ever needed.

To test the JavaScript version, enter your information below:

UserId (or email address):

Password:

VendorAndVersion:

Function:

Url: http://WebServices.GamesByEmail.com/JavaScript/MyTurns?

UserId (or email address):
Password:
VendorAndVersion:
Function:
Url:	http://WebServices.GamesByEmail.com/JavaScript/MyTurns?