Notes.get
From Facebook Developer Wiki
Contents |
Description
Returns a list of all of the visible notes written by the specified user. If the user is logged out, only publicly viewable notes get returned.
For desktop applications, this call works only for the logged-in user, since that's the only session you have. If you want data for other users, make an FQL query (fql.query) on the note (FQL) table.
Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. If you specify the API key in your client, you don't need to pass it with every call. | |
|---|---|---|---|---|
| call_id | float | The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. If you specify the call ID in your client, you don't need to pass it with every call. | ||
| sig | string | An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. Facebook computes the signature for you automatically. | ||
| v | string | This must be set to 1.0 to use this version of the API. If you specify the version in your client, you don't need to pass it with every call. | ||
| session_key | string | The session key of the logged in user, or the session key provided when the user granted your application the offline_access extended permission. The session key is automatically included by our PHP client. | ||
| optional | format | string | The desired response format, which can be either XML or JSON. (Default value is XML.) | |
| callback | string | Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter. | ||
| uid | int | The user ID of the user whose notes you want to retrieve. For desktop applications, don't specify a uid; keep the default. (Default value is the logged-in user.) |
Example Requests
Response
This method returns an array of notes with their data in their respective fields (note_id, title, content, created_time, updated_time, uid).
Privacy Note: The note IDs returned are the notes that are visible to the current user via Facebook Platform. If no notes are found, the method returns an empty notes_get_response element.
Example Return JSON
FQL Equivalent
FQL queries take the form: SELECT <fields> FROM <table> WHERE <conditions>
This function is similar (but returned in a slightly different format) to doing the following FQL query, with the appropriate parameters filled in:
Error Codes
For a complete list of error codes, see 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. | |
| 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. | |
| 103 | The submitted call_id was not greater than the previous call_id for this session. | |
| 104 | Incorrect signature. | |
| 281 | Managing notes requires the extended permission create_note, |
