Log In Join Now
Forums  |  Help  |  Settings  |  Download
Help: Topic
 
Getting Started
Overview
Website
Forums
Project Progress
Project Updates
API
What is World Community Grid?
Costs
Social Networking
FightAIDS@Home - Phase 2
Project information
Scientific background
Project graphics
Outsmart Ebola Together
Project information
Scientific background
Project graphics
Uncovering Genome Mysteries
Project information
Scientific background
Project graphics
Mapping Cancer Markers
Project information
Scientific background
Project graphics
Computing for Sustainable Water
Say No to Schistosoma
GO Fight Against Malaria
Drug Search for Leishmaniasis
Computing for Clean Water
The Clean Energy Project - Phase 2
Discovering Dengue Drugs - Together - Phase 2
Help Cure Muscular Dystrophy - Phase 2
Influenza Antiviral Drug Search
Help Fight Childhood Cancer
The Clean Energy Project
Nutritious Rice for the World
Help Conquer Cancer
AfricanClimate@Home
Discovering Dengue Drugs - Together
Help Cure Muscular Dystrophy
Genome Comparison
Help Defeat Cancer
FightAIDS@Home
Human Proteome Folding
Human Proteome Folding - Phase 2
Points
Returning Results
Teams
Team Challenges
Help Stop TB
Project information
Scientific background
Project graphics
OpenZika
Project information
Scientific background
Project graphics
Smash Childhood Cancer
Project information
Project graphics
Microbiome Immunity Project
Project information
Scientific and technical background
Project graphics
Africa Rainfall Project
OpenPandemics - COVID-19
Project Information
Scientific and Technical Background
Project Graphics
Troubleshooting
Search for help about: Go
 

API


Do you have an XML interface for the statistics?

You may obtain an XML version for most of the public statistics pages by simply adding either "?xml=true" if there are no other parameters in the URL or "&xml=true" if there already are parameters on the URL for the page.

Alternatively, you can view the XML page and follow the references provided on that XML document to go to locate pages that are in XML format.

Return to Top 

Do you have an JSON interface for the statistics?

You may obtain an JSON version for some of the public statistics pages by simply adding either "?format=json" if there are no other parameters in the URL or "&format=json" if there already are parameters on the URL for the page.

Return to Top 

Is there an API to get a list of in-progress and recently returned results for a member?

Yes. The URL for the API to access a members results is:

https://www.worldcommunitygrid.org/api/members/{member name}/results?code={verification code}

member name is the member name of the member whose results data you wish to access
verification code is found on the My Profile page of the member whose results data you wish to access

The default format is JSON.

You must set your data sharing preferences to "Display my data" for this API to return data for your account.

Optional parameters are (can be combined):

  • Limit: Defines the number of results returned. Default is 25.  Max is 250.
  • Offset: Defines how many results are skipped before the API returns any data. Default is 0.
  • SortBy: Defines the sorting order of the results. Options are: DeviceId, SentTime, ReportDeadline, ReceivedTime or CpuTime. Default is SentTime.
  • Format: The format of the data. Options are XML or JSON. Default is JSON.
  • ModTime: Return results which were last modified on or after this time. This value is a Unixtimestamp (number of seconds since midnight Jan 1 1970).
  • ServerState: Return results based on whether they are currently in progress or have already been reported back to World Community Grid. 4 would return in-progress results, 5 would return results which have already been reported back to the server.
  • Outcome: Return results based on the outcome of their processing. 1 means success, 3 means error, 4 means no reply, 6 means validation error, 7 means abandoned./
  • ValidateState: Return results based on the validation status. 0 means pending validation, 1 means valid, 2 means invalid, 4 means pending verification, 5 means results failed to validate within given deadline.
  • FileDeleteState: Return results based on their file delete state.  0 means not deleted.  1 means ready to delete.  2 means deleted.

Return to Top 

What is the Verification Code and what is it used for?

The Verification Code is a private, personal code that you can use to verify your team membership and team stats. There are teams that provide incentives and/or rewards to members for being a part of their team. World Community Grid is providing the Verification Code as a way for these teams to verify their members' statistics and team membership without requiring members to give the team their password.

Note that your Verification Code will change if you change your member name and/or password. If your team is relying on your verification code to verify your membership and statistics, be sure they have your current Verification Code.

To verify the team membership and statistics for a member, use the API:
http://www.worldcommunitygrid.org/verifyMember.do?name=MEMBERNAME&code=VERIFICATIONCODE

You must set your data sharing preferences to "Display my data" for this API to return data for your account.

You will get a response in XML containing the membership information for that member. If there is an error, it will be reported back in the XML response.

Return to Top