Changes between Version 36 and Version 37 of SeattleGeniApi

Changes between Version 36 and Version 37 of SeattleGeniApi

Please note that these Trac pages are no longer being updated. Wiki contents/documentation have moved to GitHub.

Changes between Version 36 and Version 37 of SeattleGeniApi

Please note that these Trac pages are no longer being updated. Wiki contents/documentation have moved to GitHub.

Changes between Version 36 and Version 37 of SeattleGeniApi

Show
Ignore:
Timestamp:
07/05/12 20:38:59 (7 years ago)
Author:
leonwlaw
Comment:

Quick pass of GENI->Clearinghouse. Left link/file references intact.

Legend:

Unmodified
Added
Removed
Modified
  • SeattleGeniApi

    v36 v37  
    1 = SeattleGENI API = 
     1= Seattle Clearinghouse API = 
    22[[BR]] 
    3 An XML-RPC interface to SeattleGENI is available, for clients wishing to access SeattleGENI functionality without going through the SeattleGENI website. The XML-RPC server is located at the following address: {{{https://seattlegeni.cs.washington.edu/xmlrpc/}}} 
     3An XML-RPC interface to Seattle Clearinghouse is available, for clients wishing to access Seattle Clearinghouse functionality without going through the Seattle Clearinghouse website. The XML-RPC server is located at the following address: {{{https://seattlegeni.cs.washington.edu/xmlrpc/}}} 
    44 
    5 For examples on how to use XML-RPC with SeattleGENI, check out the [wiki:SeattleGeniClientLib SeattleGENI XML-RPC Client Library]. 
     5For examples on how to use XML-RPC with Seattle Clearinghouse, check out the [wiki:SeattleGeniClientLib Seattle Clearinghouse XML-RPC Client Library]. 
    66 
    77[[BR]] 
    88=== Authentication === 
    9 In order to talk with SeattleGENI over XML-RPC, authentication is required.[[BR]] 
     9In order to talk with Seattle Clearinghouse over XML-RPC, authentication is required.[[BR]] 
    1010The authentication structure takes the form of the following dictionary: 
    1111   ''{'username':'YOUR_USERNAME', 'api_key':'YOUR_API_KEY'}'' 
    1212 
    13 The value of ''YOUR_USERNAME'' is the same username you use to login to the SeattleGENI website. The value of ''YOUR_API_KEY'' is the API key you can find on SeattleGENI when viewing the profile page for your account.[[BR]] 
     13The value of ''YOUR_USERNAME'' is the same username you use to login to the Seattle Clearinghouse website. The value of ''YOUR_API_KEY'' is the API key you can find on Seattle Clearinghouse when viewing the profile page for your account.[[BR]] 
    1414[[BR]] 
    1515'''This structure is expected as the first argument in every XML-RPC API call (except where otherwise noted).[[BR]]''' 
     
    5050      ''expires_in_seconds'' is an integer representing the number of seconds until this vessel's acquisition will expire.[[BR]] 
    5151 
    52 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     52Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    5353Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    5454Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
    5555Raises an XML-RPC Fault Code 103 if the account doesn't have enough credits available to acquire the requested vessels.[[BR]] 
    56 Raises an XML-RPC Fault Code 105 if SeattleGENI could not fulfill the request (e.g. there are not enough vessels of the requested type available).[[BR]] 
     56Raises an XML-RPC Fault Code 105 if Seattle Clearinghouse could not fulfill the request (e.g. there are not enough vessels of the requested type available).[[BR]] 
    5757 
    5858[[BR]] 
     
    6767Returns a list of dictionaries like that returned by '''acquire_resources'''. 
    6868 
    69 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     69Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    7070Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    7171Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    7878Release resources (vessels) previously acquired by the account.  The handles in '''list_of_handles''' indicate the vessels to be released. 
    7979 
    80 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     80Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    8181Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    8282Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    8888Renew resources (vessels) previously acquired by the account.  The handles in '''list_of_handles''' indicate the vessels to be renewed. Vessels are renewed for 7 days. 
    8989 
    90 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     90Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    9191Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    9292Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    101101The return list is of the same form as returned by acquire_resources. 
    102102 
    103 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     103Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    104104Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    105105Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    118118      ''user_affiliation'' is a string and represents the affiliation provided by the user when registering for an account.   This field is not validated so should not be trusted.[[BR]] 
    119119 
    120 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     120Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    121121Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    122122Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    128128Returns the user's public key as a string. 
    129129 
    130 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     130Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    131131Raises an XML-RPC Fault Code 101 if authentication failed.[[BR]] 
    132132Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
     
    141141Returns the user's api key encrypted with the user's public key. 
    142142 
    143 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     143Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    144144Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
    145145 
     
    159159Generates a new api key for the user and returns the new api key. 
    160160 
    161 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     161Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    162162Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]] 
    163163 
     
    168168Sets the user's public key. 
    169169 
    170 Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in SeattleGENI.[[BR]] 
     170Raises an XML-RPC Fault Code 1 or 100 if an internal error occurred in Seattle Clearinghouse.[[BR]] 
    171171Raises an XML-RPC Fault Code 102 if any arguments were invalid.[[BR]]