Log In Join Now
Forums  |  Help  |  Settings  |  Download
Help: Topic
 
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.

Optional parameters are (can be combined):

  • Limit: Defines the number of results returned. Default is 25.
  • 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