getUser
getUser Get information about a user from the user's token.
getUser Input
getUser is a secure API method with the following URL and HTTP header requirements:
| Submit to URL: | https://api.bonanza.com/api_requests/secure_request |
| Required in HTTP header: | X-BONANZLE-API-DEV-NAME set to your dev_id |
| X-BONANZLE-API-CERT-NAME set to your cert_id |
Note that all secure methods except for fetchToken and getBoothItems require you to submit a user token so that we know what user account you are acting on behalf of. For details about setting up and submitting user tokens, see our intro to user tokens.
The name for your request should be getUserRequest.
Here are the available input parameters that can be serialized into JSON:
| Argument | Type | Occurrence | Meaning |
|---|---|---|---|
| requesterCredentials | Container | Required | Container for user credentials |
| requesterCredentials .bonanzleAuthToken | string | Required | The verified user token for the user who you are acting on behalf of. |
| Call-specific Input Fields | |||
| No call request-specific parameters necessary. | |||
getUser Output
The name for the output returned from this request is getUserResponse. So, after parsing the serialized response into JSON, you can access the data with something like my_json_hash['getUserResponse']
Here are all the possible output parameters:
| Argument | Type | Occurrence | Meaning |
|---|---|---|---|
| Standard Output Fields | |||
| errorMessage | Container | Conditionally | Description of an error or warning that occurred when Bonanza processed the request. Not returned if the ack value is Success. |
| errorMessage.error | Container |
Conditionally, repeatable: [0..*] |
|
| errorMessage.error.category | ErrorCategory | Conditionally | Currently unused. |
| errorMessage.error.message | string | Conditionally | A description of the error |
| errorMessage.error.type | ErrorType | Conditionally | A unique descriptive name for the error. |
| timestamp | dateTime | Always | |
| Call-specific Output Fields | |||
| avatarUrl | url | Always | URL of the user's profile picture (returned as 128x128 image). |
| billingEmail | string | Always | Seller's Paypal email address. |
| bonanzaGoodStanding | boolean | Always | "true" if user's account is in active, good standing. |
| string | Always | Email address. | |
| feedbackScore | integer | Always | Seller's numeric feedback score |
| postiveFeedbackPercentage | integer | Always | The seller's numeric positive feedback percentage, as an integer. |
| registrationAddress | container | Always | Container for seller's address information. |
| registrationAddress.cityName | string | Always | Name of the user's city. |
| registrationAddress.country | string | Always | Two digit code for the user's country. |
| registrationAddress.name | string | Always | User's first and last name. |
| registrationAddress.postalCode | string | Always | Like it says. |
| registrationAddress.street1 | string | Always | First line of user's address. |
| registrationAddress.street2 | string | Always | Second line of user's address. |
| sellerInfo | container | Always | Container for a seller's info. |
| sellerInfo.storeOwner | boolean | Always | "true" if the user is a seller |
| sellerInfo.storeURL | uri | Always | URL of the user's store |
| userID | integer | Always | Bonanza unique identifier for this user |
| userName | string | Always | User's Bonanza user name |
