|
| Jun 29 |
|
| Jan 29 |
|
| Jan 14 |
|
| Dec 2 |
|
| Nov 24 |
|
| Nov 24 |
|
| Nov 20 |
|
| Oct 21 |
|
| Aug 22 |
|
| Jul 24 |
Brightkite API Object ReferenceThis document contains JSON and XML examples for the objects that are available from the Brightkite REST API. Refer to the REST API document for instructions and examples on accessing the API. N.B. Most of these examples were created with mock or test data. They are intended to give examples of the data that is returned from the API. Most of the user names, URLs and IDs here will not work with the API so please do not attempt to use them, they are only examples. BlockProperties: blocker: user name of the person who created the block. blockee: user name of the person who is being blocked. created_at: timestamp when the block was created. JSON: { "object_type": "block", "blocker": "FrankZappa", "blockee": "batman", "created_at": "2008/07/10 20:08:35 +0000" }
XML: <block> <blocker>FrankZappa</blocker> <blockee>batman</blockee> <created_at type="datetime">2008-07-10T20:08:35Z</created_at> </block> CheckinProperties: id: the checkin object's Brightkite UUID. place: Place object for this checkin. creator: Person object for the user who created the checkin. public: boolean created_at: timestamp for when the checkin was created. created_at_ts: Checkin creation time in unix timestamp format. created_at_as_words: Textual representation of when the checkin was created, suitable for displaying. comments_count: Count of comments for checkin. JSON: { "object_type": "checkin", "public": false, "created_at_as_words": "13 days", "created_at": "2008/11/19 08:39:56 +0000", "place": { "longitude": -122.503856, "display_location": "123 Main St, City, ST 12345, USA", "latitude": 37.762515, "scope": "address", "name": "Name of Location", "id": "102af83cbed832cefa8310482ae6be3" }, "comments_count": 0, "created_at_ts": "1227083996.132682", "creator": { "tiny_avatar_url": "http://s3.amazonaws.com/bk_store/images/user/avatar/43f28cde9b4811ddb72b003048c0801e/avatar-tiny.png", "fullname": "John Barker", "small_avatar_url": "http://s3.amazonaws.com/bk_store/images/user/avatar/43f28cde9b4811ddb72b003048c0801e/avatar-small.png", "login": "barkerja", "smaller_avatar_url": "http://s3.amazonaws.com/bk_store/images/user/avatar/43f28cde9b4811ddb72b003048c0801e/avatar-smaller.png" }, "id": "a47edafcb61511dd8a24003048c0801e" } XML: <checkin> CommentProperties: place_object: Note or Photo object that this comment belongs to. user: Person object for the user who created the comment. comment: text of the comment. created_at: timestamp for when the comment was created.
JSON: { "object_type": "comment", "place_object": { "body": "a new note", "creator": { "fullname": "", "login": "firetoad", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "public": true, "created_at_as_words": "28 days", "about": false, "id": "7719a1c782a1ba91c031a682a0a2f8658209adbf", "place": { "longitude": "-104.978101", "scope": "address", "latitude": "39.712884", "name": "201 S Clarkson St, Denver, CO 80209, USA", "display_location": "201 S Clarkson St, Denver, CO 80209, USA", "id": "f1abd670358e036c31296e66b3b66c382ac00812" }, "created_at": "2008/06/12 18:45:18 +0000" }, "user": { "last_checked_in": "2008/07/08 20:19:59 +0000", "age": null, "fullname": "", "login": "firetoad", "website": "", "description": "GA:LEIR{JBGes[R*h30rheasOLFhESrtuhw2rt9hwet9q3784ht[q934hrtq[kehs;rf;ghkj[or239203h", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "sex": "male", "tiny_avatar_url": "/images/default_user_avatar_tiny.png", "place": { "longitude": "-104.982256", "scope": "address", "latitude": "39.762314", "name": "2911 Walnut St, Denver, CO 80205, USA", "display_location": "2911 Walnut St, Denver, CO 80205, USA", "id": "1574bddb75c78a6fd2251d61e2993b5146201319" } }, "comment": "wooo comment!", "created_at": "2008/06/12 21:59:27 +0000" }
XML: <comment> <place_object> <body>a new note</body> <creator> <fullname></fullname> <login>firetoad</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </creator> <public type="boolean">true</public> <created_at_as_words>28 days</created_at_as_words> <about type="boolean">false</about> <id>7719a1c782a1ba91c031a682a0a2f8658209adbf</id> <place> <longitude>-104.978101</longitude> <scope>address</scope> <latitude>39.712884</latitude> <name>201 S Clarkson St, Denver, CO 80209, USA</name> <display_location>201 S Clarkson St, Denver, CO 80209, USA</display_location> <id>f1abd670358e036c31296e66b3b66c382ac00812</id> </place> <created_at type="datetime">2008-06-12T18:45:18Z</created_at> </place_object> <user> <last_checked_in type="datetime">2008-07-08T20:19:59Z</last_checked_in> <age nil="true"></age> <fullname></fullname> <login>firetoad</login> <website></website> <description>GA:LEIR{JBGes[R*h30rheasOLFhESrtuhw2rt9hwet9q3784ht[q934hrtq[kehs;rf;ghkj[or239203h</description> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <sex>male</sex> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> <place> <longitude>-104.982256</longitude> <scope>address</scope> <latitude>39.762314</latitude> <name>2911 Walnut St, Denver, CO 80205, USA</name> <display_location>2911 Walnut St, Denver, CO 80205, USA</display_location> <id>1574bddb75c78a6fd2251d61e2993b5146201319</id> </place> </user> <comment>wooo comment!</comment> <created_at type="datetime">2008-06-12T21:59:27Z</created_at> </comment> ConfigSee also: Person JSON: { "nearby_notifications": true, "nearby_post_sms_notifications": true, "private_posts_visibility_trusted_friends": "exact", "notify_twitter_text": true, "website": "", "notify_friendships_email": true, "private_checkins_visibility": "city", "tiny_avatar_url": "/images/default_user_avatar_tiny.png", "nearby_post_email_notifications": false, "notify_direct_message_sms": true, "private_checkins_visibility_friends": "city", "object_type": "person", "notify_twitter_photo": true, "disable_email": false, "disable_sms": false, "age": null, "sex": "male", "description": "Just another Brightkite user.", "fullname": "", "nearby_notifications_radius": 200, "private_checkins_visibility_trusted_friends": "exact", "phone": null, "notify_direct_message_email": true, "notify_twitter_checkin": true, "nearby_notifications_scope": "all", "nearby_checkin_sms_notifications": true, "private_posts_visibility": "hide", "login": "firetoad", "small_avatar_url": "/images/default_user_avatar_small.png", "nearby_notifications_radius_text": "block", "nearby_checkin_email_notifications": false, "private_posts_visibility_friends": "city", "email": "foo@bar.com", "notify_friendships_sms": false, "privacy_mode": "public", "notify_twitter_checkin_as_post": true, "smaller_avatar_url": "/images/default_user_avatar_smaller.png" } XML: <person> DirectMessageProperties: body: text of the message. status: status of the message, e.g. 'read' or 'unread'. sender: Person object for the sender of the message. recipient: Person object for the recipient of the message. created_at: timestamp for when the checkin was created. created_at_as_words: Textual representation of when the checkin was created, suitable for displaying.
JSON: { "body": "Nudge Nudge! This would be a good time to check in and post something, I'm wondering what you're up to.", "object_type": "direct_message", "created_at_as_words": "19 days", "status": "unread", "sender": { "fullname": "", "login": "firetoad", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "recipient": { "fullname": "Me!", "login": "mike", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "created_at": "2008/06/20 21:33:28 +0000" }
XML: <direct_message> <body>Nudge Nudge! This would be a good time to check in and post something, I'm wondering what you're up to.</body> <created_at_as_words>19 days</created_at_as_words> <status>unread</status> <sender> <fullname></fullname> <login>firetoad</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </sender> <recipient> <fullname>Me!</fullname> <login>mike</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </recipient> <created_at type="datetime">2008-06-20T21:33:28Z</created_at> </direct_message> FriendshipProperties: user: Person object of the user who owns this Friendship object. friendable: Person object of the user who this Friendship object relates to. trusted: boolean that indicates whether friendable is a trusted friend or not. checkin_stream_feeding: boolean indicating whether friendable's checkins show up in user's stream. checkin_sms_notifications:boolean indicating whether friendable's checkins are sent to user's phone via SMS. checkin_email_notifications: boolean indicating whether friendable's checkins are sent to user's email. post_stream_feeding: boolean indicating whether friendable's posts show up in user's stream. post_sms_notifications: boolean indicating whether friendable's posts are sent to user's phone via SMS. post_email_notifications: boolean indicating whether friendable's posts are sent to user's email. created_at: timestamp for when the friendship was created. JSON: { "post_email_notifications": false, "object_type": "friendship", "trusted": false, "checkin_stream_feeding": true, "checkin_sms_notifications": false, "friendable": { "fullname": "", "login": "firetoad", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "user": { "fullname": "Me!", "login": "mike", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "checkin_email_notifications": false, "post_stream_feeding": true, "created_at": "2008/06/18 22:50:17 +0000", "post_sms_notifications": false }
XML: <friendship> <post_email_notifications type="boolean">false</post_email_notifications> <trusted type="boolean">false</trusted> <checkin_stream_feeding type="boolean">true</checkin_stream_feeding> <checkin_sms_notifications type="boolean">false</checkin_sms_notifications> <friendable> <fullname></fullname> <login>firetoad</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </friendable> <user> <fullname>Me!</fullname> <login>mike</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </user> <checkin_email_notifications type="boolean">false</checkin_email_notifications> <post_stream_feeding type="boolean">true</post_stream_feeding> <created_at type="datetime">2008-06-18T22:50:17Z</created_at> <post_sms_notifications type="boolean">false</post_sms_notifications> </friendship> NoteProperties: id: Brightkite UUID. body: text of the note. creator: Person object for the user who created the note. place: Place object where this note was posted. public: boolean. about: boolean. created_at: timestamp for when the note was created. JSON: { "body": "No para hasta conquistar! Vamos Espa\\u00f1a!", "creator": { "fullname": null, "login": "FrankZappa", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "public": true, "object_type": "note", "created_at_as_words": "9 days", "about": true, "id": "fe2ef495a1152561572949784c16bf23abb28057", "place": { "longitude": "-95.712891", "scope": "country", "latitude": "37.090240", "name": "USA", "display_location": "USA", "id": "da4b9237bacccdf19c0760cab7aec4a8359010b0" }, "created_at": "2008/07/01 16:57:37 +0000" } <note> <body>No para hasta conquistar! Vamos España!</body> <creator> <fullname nil="true"></fullname> <login>FrankZappa</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </creator> <public type="boolean">true</public> <created_at_as_words>9 days</created_at_as_words> <about type="boolean">true</about> <id>fe2ef495a1152561572949784c16bf23abb28057</id> <place> <longitude>-95.712891</longitude> <scope>country</scope> <latitude>37.090240</latitude> <name>USA</name> <display_location>USA</display_location> <id>da4b9237bacccdf19c0760cab7aec4a8359010b0</id> </place> <created_at type="datetime">2008-07-01T16:57:37Z</created_at> </note> PersonProperties: login: login name for the user. fullname: optional full name of the user. description: optional description of the user. age: optional age of the user. sex: can be "male", "female", or "unspecified". website: optional link to the user's website. small_avatar_url: 48x48 pixel avatar image for the user. smaller_avatar_url: 32x32 pixel avatar image. tiny_avatar_url: 16x16 pixel avatar image. JSON: { "last_checked_in": null, "object_type": "person", "age": null, "fullname": null, "login": "FrankZappa", "website": null, "description": "Totally sweet", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "sex": "unspecified", "tiny_avatar_url": "/images/default_user_avatar_tiny.png", "place": null } <person> <last_checked_in nil="true"></last_checked_in> <age nil="true"></age> <fullname nil="true"></fullname> <login>FrankZappa</login> <website nil="true"></website> <description>Totally sweet</description> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <sex>unspecified</sex> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> <place nil="true"></place> </person> PhotoProperties: id: Brightkite UUID creator: Person object for the user who posted the photo. place: Place object that this photo was posted at. photo: link to the photo for this object. body: optional caption for the photo. public: boolean about: boolean created_at: timestamp for when the photo was created. created_at_as_words: Textual representation of when the photo was created, suitable for displaying.
JSON: { "created_at": "2008/07/03 19:53:58 +0000", "creator": { "smaller_avatar_url": "/images/user/avatar/2292/me-smaller.png", "login": "mcollins", "tiny_avatar_url": "/images/user/avatar/2292/me-tiny.png", "fullname": "M. Collins", "small_avatar_url": "/images/user/avatar/2292/me-small.png" }, "public": true, "about": false, "object_type": "photo", "created_at_as_words": "7 days", "place": { "name": "Brightkite HQ", "longitude": "-104.982480", "latitude": "39.762146", "scope": "address", "id": "356a192b7913b04c54574d18c28d46e6395428ab", "display_location": "2911 Walnut St, Denver, CO 80205, USA" }, "body": "\u00a1El Ni\u00f1o!", "id": "3a76426bffc90ffae044d5b29b10be6350a27397", "photo": "http://brightkite.com/images/photo_object/photos/4/0/402907/elnino33.jpg" } XML: <photo> PlaceProperties: id: Brightkite UUID name: Name of the place. display_location: Name of the place suitable for displaying. scope: level of geographical accuracy for this place, e.g. country, city, address street: street address for this place, if it has one. street2: optional second line of street address city: city if it has one. state: state if it has one. zip: zip or postal code. country: country. latitude: latitude (float) longitude: longitude (float) JSON: { "longitude": "-95.712891", "object_type": "place", "scope": "country", "latitude": "37.090240", "street2": null, "street": null, "country": "US", "state": null, "name": "USA", "display_location": "USA", "city": null, "zip": null, "id": "da4b9237bacccdf19c0760cab7aec4a8359010b0" }
XML: <place> <longitude>-95.712891</longitude> <scope>country</scope> <latitude>37.090240</latitude> <street2 nil="true"></street2> <street nil="true"></street> <country>US</country> <state nil="true"></state> <name>USA</name> <display_location>USA</display_location> <city nil="true"></city> <zip nil="true"></zip> <id>da4b9237bacccdf19c0760cab7aec4a8359010b0</id> </place> PlacemarkProperties: placemark: name of the placemark. user: Person object for the user who created it. place: Place object for the placemark. created_at: timestamp for when the placemark was created.
JSON: { "object_type": "placemark", "placemark": "blee", "user": { "fullname": "", "login": "firetoad", "small_avatar_url": "/images/default_user_avatar_small.png", "smaller_avatar_url": "/images/default_user_avatar_smaller.png", "tiny_avatar_url": "/images/default_user_avatar_tiny.png" }, "place": { "longitude": "-105.256712", "scope": "address", "latitude": "40.044001", "name": "3850 Paseo del Prado St, Boulder, CO 80301, USA", "display_location": "3850 Paseo Del Prado St, Boulder, CO 80301, USA", "id": "356a192b7913b04c54574d18c28d46e6395428ab" }, "created_at": "2008/06/10 16:36:31 -0600" } <placemark> <placemark>blee</placemark> <user> <fullname></fullname> <login>firetoad</login> <small_avatar_url>/images/default_user_avatar_small.png</small_avatar_url> <smaller_avatar_url>/images/default_user_avatar_smaller.png</smaller_avatar_url> <tiny_avatar_url>/images/default_user_avatar_tiny.png</tiny_avatar_url> </user> <place> <longitude>-105.256712</longitude> <scope>address</scope> <latitude>40.044001</latitude> <name>3850 Paseo del Prado St, Boulder, CO 80301, USA</name> <display_location>3850 Paseo Del Prado St, Boulder, CO 80301, USA</display_location> <id>356a192b7913b04c54574d18c28d46e6395428ab</id> </place> <created_at type="datetime">2008-06-10T16:36:31-06:00</created_at> </placemark>
|
|
| Create a group - Google Groups - Google Home - Terms of Service - Privacy Policy |
| ©2010 Google |