<<O>>  Difference Topic AccountOperations (r1.4 - 04 Mar 2008 - Home.michal)

META TOPICPARENT APIDraft

Account Operations

Line: 16 to 16

GET /User/GPUData Get a user's GPU information. Get User GPU Information Command Yes
GET /User/Interests Get the user's interests. Get User Interests Command Yes
GET /User/Inventory Get the user's inventory. Get User Inventory Command Yes
Added:
>
>
GET /User/LoginMessage Get a message for this user at login, if any. Get User Login Message No

GET /User/MobileLevel Get the user's Mobile Level. Get User's Mobile Level Command Yes
GET /User/Pets Get a list of pets that the user owns. Get User Pets Command Yes
GET /User/Profile Get more detailed information about the user. Get User Profile Command Yes
 <<O>>  Difference Topic AccountOperations (r1.3 - 26 Feb 2008 - Home.rallison)

META TOPICPARENT APIDraft

Account Operations

Line: 23 to 23

GET /User/Suitcase Get items from user's suitcase. Get User Suitcase Command Yes
GET /User/WishList Get which items that are on the user's wish list. Get User Wish List Command Yes
PUT /User/ContactInformation Change the user's contact information. Change User Contact Information Command Yes
Changed:
<
<
PUT /User/GPUData Change the user's GPU information. Change User GPU Information Command Almost Finished
>
>
PUT /User/GPUData Change the user's GPU information. Change User GPU Information Command Yes

PUT /User/Interests Change the user's interests. Change User Interests Command Yes
PUT /User/MobileLevel Change the user's Mobile Level. Change User's Mobile Level Command Yes
PUT /User/Profile Change some of the user's profile information. Change User Profile Command Yes
 <<O>>  Difference Topic AccountOperations (r1.2 - 26 Feb 2008 - Home.rallison)

META TOPICPARENT APIDraft

Account Operations

Line: 13 to 13

GET /User Get a short version of user information, including account number, user ID and location. Get User Command Yes
GET /User/Bought Get a list of items a user has purchased. Get User Bought Information Command Yes
GET /User/ContactInformation Get a user's contact information. Get User Contact Information Command Yes
Added:
>
>
GET /User/GPUData Get a user's GPU information. Get User GPU Information Command Yes

GET /User/Interests Get the user's interests. Get User Interests Command Yes
GET /User/Inventory Get the user's inventory. Get User Inventory Command Yes
GET /User/MobileLevel Get the user's Mobile Level. Get User's Mobile Level Command Yes
Line: 22 to 23

GET /User/Suitcase Get items from user's suitcase. Get User Suitcase Command Yes
GET /User/WishList Get which items that are on the user's wish list. Get User Wish List Command Yes
PUT /User/ContactInformation Change the user's contact information. Change User Contact Information Command Yes
Added:
>
>
PUT /User/GPUData Change the user's GPU information. Change User GPU Information Command Almost Finished

PUT /User/Interests Change the user's interests. Change User Interests Command Yes
PUT /User/MobileLevel Change the user's Mobile Level. Change User's Mobile Level Command Yes
PUT /User/Profile Change some of the user's profile information. Change User Profile Command Yes
 <<O>>  Difference Topic AccountOperations (r1.1 - 01 Nov 2007 - Home.michal)
Line: 1 to 1
Added:
>
>
META TOPICPARENT APIDraft

Account Operations

Account Information

Account information is retrieved under the /User URI. See below for details of what data is returned for various resources. In addition, a single field may be requested by specifying it in the URI, ex. "GET /User/Email". By default, data is retrieved for the authenticated user. Data for other users may be requested by using the AccountNo or UserID parameter, ex. "GET /User/Profile?AccountNo=172". Data on other user accounts is subject to the user's privacy settings.

Command Description Reference Implemented
DELETE /User/Suitcase Delete item from user's suitcase. Delete item from Suitcase Command Yes
DELETE /User/WishList Remove items from the wish list. Delete from the Wish List Command Yes
GET /User Get a short version of user information, including account number, user ID and location. Get User Command Yes
GET /User/Bought Get a list of items a user has purchased. Get User Bought Information Command Yes
GET /User/ContactInformation Get a user's contact information. Get User Contact Information Command Yes
GET /User/Interests Get the user's interests. Get User Interests Command Yes
GET /User/Inventory Get the user's inventory. Get User Inventory Command Yes
GET /User/MobileLevel Get the user's Mobile Level. Get User's Mobile Level Command Yes
GET /User/Pets Get a list of pets that the user owns. Get User Pets Command Yes
GET /User/Profile Get more detailed information about the user. Get User Profile Command Yes
GET /User/Shells Get how many shells the user has. Get User Shells Command Yes
GET /User/Suitcase Get items from user's suitcase. Get User Suitcase Command Yes
GET /User/WishList Get which items that are on the user's wish list. Get User Wish List Command Yes
PUT /User/ContactInformation Change the user's contact information. Change User Contact Information Command Yes
PUT /User/Interests Change the user's interests. Change User Interests Command Yes
PUT /User/MobileLevel Change the user's Mobile Level. Change User's Mobile Level Command Yes
PUT /User/Profile Change some of the user's profile information. Change User Profile Command Yes
PUT /User/Suitcase Add an item to the user's suitcase. Add item to Suitcase Command Yes
PUT /User/WishList Add an item to the user's wish list. Add to the Wish List Command Yes

Modifying Information - PUT Operations

In order to modify or insert data into the user account, an HTTP PUT request should be generated, targeted on the resource to be altered. The response will indicate successful update or failure by returning the appropriate data or error message. Not every operation is supported by every caller via this API. For instance, we won't allow users to add any kind of shells to their account. Also user information can only be changed by the particular user (using their UserID and password to authenticate the message).

NOTE: All PUT operations require a successfully authenticated request.

Sample PUT Request

PUT /User/ContactInformation HTTP/1.0
Authorization: GPAPI cbscribe:7VBlglEAtqiZ1dRiOuoD5YhVE+ECB-
Content-Type: text/html
Date: Sun, 25 Jun 2006 09:49:44 GMT
X-GP-DevToken: 44CF9590006BF252F707
X-GP-ID: cbscribe

<UserContactInformationRequest>
   <Phone>+82-10-9624-7006</Phone>
</UserContactInformationRequest>

Examples

To retrieve information about a particular GoPets user, use the GET operation on the User URI.

Sample Request

GET /User/Pets HTTP/1.0
Authorization: GPAPI 15B4D3461F177624206A:J3dZMRrvG+00yAeI3zNev33KH8g=
Content-Type: text/html
Date: Sun, 26 Jun 2006 07:13:49 GMT
X-GP-DevToken: 44CF9590006BF252F707
X-GP-ID: cbscribe

Sample Response

HTTP/1.1 200 OK
x-gp-request-id: kWKN9dJip1L
x-gp-api-version: 20060620
Date: Sun, 26 Jun 2006 07:13:49 GMT
Content-Type: application/xml
Content-Length: 302
Connection: close
Server: GPAPI

<?xml version="1.0" encoding="UTF-8"?>

<UserPetsResult>
   <Pet>
      <PetNo>10718</PetNo>
      <Name>Machka</PetName>
      <Breed>Cat</Breed>
      <Gender>Female</Gender>
      <PetPictureNo>10718_1</PetPictureNo>
      <PetPictureURL>http://iku.gopetslive.com/PetPortrait/PetPortrait_10718_1.jpg</PetPictureURL>
   </Pet>
   <Pet>
      <PetNo>654798</PetNo>
      <Name>Pasha</PetName>
      <Breed>Dog</Breed>
      <Gender>Male</Gender>
      <PetPictureNo>654798_1</PetPictureNo>
      <PetPictureURL>http://iku.gopetslive.com/PetPortrait/PetPortrait_654798_1.jpg</PetPictureURL>
   </Pet>
   <Pet>
      <PetNo>987354</PetNo>
      <Name>Spot</PetName>
      <Breed>Cat</Breed>
      <Gender>Male</Gender>
      <PetPictureNo>987354_1</PetPictureNo>
      <PetPictureURL>http://iku.gopetslive.com/PetPortrait/PetPortrait_987354_1.jpg</PetPictureURL>
   </Pet>
</UserPetsResult>

Back to APIDraft

View topic | Diffs | r1.4 | > | r1.3 | > | r1.2 | More
Revision r1.1 - 01 Nov 2007 - 10:26 - Home.michal
Revision r1.4 - 04 Mar 2008 - 16:47 - Home.michal