Up.profile.getUPML
Gets the UPML that is currently set for a user's profile. See the UPML documentation for a description of the markup and its role in various contexts.
Parameters
| Type
| Name
| Required
| Description
|
string
| api_key
| ✔
| The application key associated with the calling application.
|
string
| community
| ✔
| Community system name. Use up.community.getList method to retrieve available communities.
|
string
| session_key
| ✔
| The session key of the logged in user.
|
string
| sig
| ✔
| An MD5 hash of the current request and your secret key, as described in the authentication guide.
|
string
| format |
| Desired response format. Either XML (default) or JSON.
|
int
| uid |
| The user whose profile UPML is to be fetched. If not specified, defaults to the logged-in user. Not allowed for desktop applications (since the application secret is essentially public).
|
Example Return XML
<?xml version="1.0" encoding="UTF-8"?>
<profile_getUPML_response>
<up:if-is-own-profile>My profile!
<up:else> Not my profile!</up:else>
</up:if-is-own-profile>
</profile_getUPML_response>
Error codes
| Code
| Description
|
| 1
| An unknown error occurred. Please resubmit the request.
|
| 2
| The service is not available at this time.
|
| 4
| The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
|
| 5
| The request came from a remote address not allowed by this application.
|
| 100
| One of the parameters specified was missing or invalid.
|
| 101
| The api key submitted is not associated with any known application.
|
| 102
| The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
|
| 104
| Incorrect signature.
|