HipGeo Objects

Journal Entry Object

The journal is a list of location, travel, and comment entries that are ordered by time. A journal entry object is a single item in a journal. Comments and media may be attached to journal entries. Journal objects are viewable by different users based on its privacy: attribute:

  • 0 = Public
  • 3 = Private
  • 7 = Auto private

Parameter notes=1 will return the total number of likes and comments for that journal entry in the notes:{count} attribute.

In general, journal entries are retrieved using the journal endpoint which can return large numbers of entries in a single API request.

Journal entry objects support the GET and PUT methods.

GET Journal Entry Object Example

GET http://api.hipgeo.com/j_101418?access_token=TOKENVALUE

Returns:
{
  "journalentry":{
    "id":"j_101418",
    "from":{
      "id":"u_111",
      "name":"Joe",
      "shareable":1,
      "pingable":1,
      "url":"http:\/\/www.hipgeo.com\/Joe",
      "fullname":"Joe Chan",
      "avatar":{
        "id":"m_11101",
        "shareable":0,
        "type":0,
        "when":"2012-01-06 22:42:29",
        "icon":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_m?11101",
        "icon_l":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_l?11101",
        "icon_b":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_b?11101",
        "full":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_d?11101",
        "height":494,
        "width":662
      },
      "photo":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_b?11101"
    },
    "type":2,
    "when":"2012-01-26 16:02:57.595",
    "user_when":"2012-01-26 08:02:57.595",
    "privacy":0,
    "user_modified":0,
    "shareable":1,
    "liked":0,
    "title":"Private Place in Diamond Bar, CA",
    "content":"Diamond Bar, CA at 8:02am PST for a few minutes.",
    "tags":"diamond bar, california",
    "location":{
      "id":"l_112547",
      "shareable":1,
      "canmerge":1,
      "title":"Private Place in Diamond Bar, CA",
      "duration":0,
      "duration_sec":0,
      "hidestats":1,
      "uid":"u_111",
      "type":1,
      "coord":{
        "lat":33.993741,
        "lon":-117.81685,
        "radius":0
      },
      "pid":"p_5706",
      "starttime":"2012-01-26 16:02:57.595",
      "endtime":"2012-01-26 16:02:57.595",
      "gll_count":1,
      "pinpointed":1,
      "autopinpointed":1,
      "address":{
        "city":"Diamond Bar",
        "state":"CA",
        "country":"US"
      },
      "jid":"j_101418"
    },
    "commentcount":1,
    "likecount":4,
    "comments":{
      "count":1,
      "data":[
        {
          "id":"c_4033",
          "type":64,
          "shareable":true,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_356",
            "name":"HotChocolata",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/HotChocolata",
            "fullname":"Hot Chocolata",
            "avatar":{
              "id":"m_20994",
              "shareable":0,
              "type":0,
              "when":"2012-02-03 23:48:19",
              "icon":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_m?20994",
              "icon_l":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_l?20994",
              "icon_b":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994",
              "full":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_d?20994",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994"
          },
          "when":"2012-01-27 04:22:57",
          "message":"OMG!!!!! Yummyyyy... Recipe please... :)"
        }
      ]
    },
    "likes":{
      "count":4,
      "data":[
        {
          "id":"k_2572",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_31",
            "name":"rich",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/rich",
            "fullname":"Rich Rygg",
            "avatar":{
              "id":"m_9376",
              "shareable":0,
              "type":0,
              "when":"2011-12-03 03:42:12",
              "icon":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_m?9376",
              "icon_l":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_l?9376",
              "icon_b":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_b?9376",
              "full":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_d?9376",
              "height":662,
              "width":497
            },
            "photo":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_b?9376"
          },
          "when":"2012-01-26 16:11:32",
          "message":"rich likes this"
        },
        {
          "id":"k_2588",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_88",
            "name":"Steve",
            "shareable":1,
            "pingable":0,
            "url":"http:\/\/www.hipgeo.com\/Steve",
            "fullname":"Steve Alvarez",
            "avatar":{
              "id":"m_25935",
              "shareable":0,
              "type":0,
              "when":"2012-02-24 19:08:59",
              "icon":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_m?25935",
              "icon_l":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_l?25935",
              "icon_b":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_b?25935",
              "full":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_d?25935",
              "height":"662",
              "width":"662"
            },
            "photo":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_b?25935"
          },
          "when":"2012-01-26 18:14:28",
          "message":"Steve likes this"
        },
        {
          "id":"k_2592",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_329",
            "name":"ccorona27",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/ccorona27",
            "fullname":"Mahmud Mahmudzade",
            "avatar":{
              "id":"m_23492",
              "shareable":0,
              "type":0,
              "when":"2012-02-12 17:06:06",
              "icon":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_m?23492",
              "icon_l":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_l?23492",
              "icon_b":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_b?23492",
              "full":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_d?23492",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_b?23492"
          },
          "when":"2012-01-26 18:36:27",
          "message":"ccorona27 likes this"
        },
        {
          "id":"k_2635",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_356",
            "name":"HotChocolata",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/HotChocolata",
            "fullname":"Hot Chocolata",
            "avatar":{
              "id":"m_20994",
              "shareable":0,
              "type":0,
              "when":"2012-02-03 23:48:19",
              "icon":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_m?20994",
              "icon_l":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_l?20994",
              "icon_b":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994",
              "full":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_d?20994",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994"
          },
          "when":"2012-01-27 04:23:05",
          "message":"HotChocolata likes this"
        }
      ]
    },
    "mediacount":1,
    "media":{
      "count":1,
      "data":[
        {
          "id":"m_18638",
          "shareable":1,
          "type":0,
          "when":"2012-01-26 21:51:54",
          "icon":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_m.jpg?18638",
          "icon_l":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_l.jpg?18638",
          "icon_b":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_b.jpg?18638",
          "full":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_d.jpg?18638",
          "height":"662",
          "width":"494"
        }
      ]
    }
  },
  "result":"success",
  "st":1333134735
} 
Error Code Possible Errors
401
  1. Authentication failed
  2. Token expired
  3. Insufficient Permission
  4. 'me' requires authentication
404
  1. ID not found
  2. Bad ID

GET Journal Entry Object Example. notes=1

GET http://api.hipgeo.com/j_101418?notes=1&access_token=TOKENVALUE

Returns:
{
  "journalentry":{
    "id":"j_101418",
    "from":{
      "id":"u_111",
      "name":"Joe",
      "shareable":1,
      "pingable":1,
      "url":"http:\/\/www.hipgeo.com\Joe",
      "fullname":"Joe Chan",
      "avatar":{
        "id":"m_11101",
        "shareable":0,
        "type":0,
        "when":"2012-01-06 22:42:29",
        "icon":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_m?11101",
        "icon_l":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_l?11101",
        "icon_b":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_b?11101",
        "full":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_d?11101",
        "height":494,
        "width":662
      },
      "photo":"http:\/\/img.hipgeo.com\/4c0faecc4ffdb3c15ea72a5f0ee8fb58_b?11101"
    },
    "type":2,
    "when":"2012-01-26 16:02:57.595",
    "user_when":"2012-01-26 08:02:57.595",
    "privacy":0,
    "user_modified":0,
    "shareable":1,
    "liked":0,
    "title":"Private Place in Diamond Bar, CA",
    "content":"Diamond Bar, CA at 8:02am PST for a few minutes.",
    "tags":"diamond bar, california",
    "location":{
      "id":"l_112547",
      "shareable":1,
      "canmerge":1,
      "title":"Private Place in Diamond Bar, CA",
      "duration":0,
      "duration_sec":0,
      "hidestats":1,
      "uid":"u_111",
      "type":1,
      "coord":{
        "lat":33.993741,
        "lon":-117.81685,
        "radius":0
      },
      "pid":"p_5706",
      "starttime":"2012-01-26 16:02:57.595",
      "endtime":"2012-01-26 16:02:57.595",
      "gll_count":1,
      "pinpointed":1,
      "autopinpointed":1,
      "address":{
        "city":"Diamond Bar",
        "state":"CA",
        "country":"US"
      },
      "jid":"j_101418"
    },
    "commentcount":1,
    "likecount":4,
    "notes":{
      "count":5,
      "data":[
        {
          "id":"k_2572",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_30",
            "name":"rich",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/rich",
            "fullname":"Rich Rygg",
            "avatar":{
              "id":"m_9376",
              "shareable":0,
              "type":0,
              "when":"2011-12-03 03:42:12",
              "icon":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_m?9376",
              "icon_l":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_l?9376",
              "icon_b":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_b?9376",
              "full":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_d?9376",
              "height":662,
              "width":497
            },
            "photo":"http:\/\/img.hipgeo.com\/4696ae45471cbe1b50c03f5e4f2e7118_b?9376"
          },
          "when":"2012-01-26 16:11:32",
          "message":"rich likes this"
        },
        {
          "id":"k_2588",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_88",
            "name":"Steve",
            "shareable":1,
            "pingable":0,
            "url":"http:\/\/www.hipgeo.com\/Steve",
            "fullname":"Steve Alvarez",
            "avatar":{
              "id":"m_25935",
              "shareable":0,
              "type":0,
              "when":"2012-02-24 19:08:59",
              "icon":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_m?25935",
              "icon_l":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_l?25935",
              "icon_b":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_b?25935",
              "full":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_d?25935",
              "height":"662",
              "width":"662"
            },
            "photo":"http:\/\/img.hipgeo.com\/4df6ade64340b1714e8c147c5231cdad_b?25935"
          },
          "when":"2012-01-26 18:14:28",
          "message":"Steve likes this"
        },
        {
          "id":"k_2592",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_329",
            "name":"ccorona27",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/ccorona27",
            "fullname":"Mahmud Mahmudzade",
            "avatar":{
              "id":"m_23492",
              "shareable":0,
              "type":0,
              "when":"2012-02-12 17:06:06",
              "icon":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_m?23492",
              "icon_l":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_l?23492",
              "icon_b":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_b?23492",
              "full":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_d?23492",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4cb7aba449b1b72464625dc86df8bb56_b?23492"
          },
          "when":"2012-01-26 18:36:27",
          "message":"ccorona27 likes this"
        },
        {
          "id":"c_4033",
          "type":64,
          "shareable":true,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_356",
            "name":"HotChocolata",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/HotChocolata",
            "fullname":"Hot Chocolata",
            "avatar":{
              "id":"m_20994",
              "shareable":0,
              "type":0,
              "when":"2012-02-03 23:48:19",
              "icon":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_m?20994",
              "icon_l":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_l?20994",
              "icon_b":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994",
              "full":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_d?20994",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994"
          },
          "when":"2012-01-27 04:22:57",
          "message":"OMG!!!!! Yummyyyy... Recipe please... :)"
        },
        {
          "id":"k_2635",
          "type":65,
          "parent":{
            "id":"j_101418",
            "uid":"u_111",
            "when":"2012-01-26 16:02:57.595"
          },
          "from":{
            "id":"u_356",
            "name":"HotChocolata",
            "shareable":1,
            "pingable":1,
            "url":"http:\/\/www.hipgeo.com\/HotChocolata",
            "fullname":"Hot Chocolata",
            "avatar":{
              "id":"m_20994",
              "shareable":0,
              "type":0,
              "when":"2012-02-03 23:48:19",
              "icon":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_m?20994",
              "icon_l":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_l?20994",
              "icon_b":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994",
              "full":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_d?20994",
              "height":662,
              "width":453
            },
            "photo":"http:\/\/img.hipgeo.com\/4e40a7f94148bf92652b4b38bf18f5ac_b?20994"
          },
          "when":"2012-01-27 04:23:05",
          "message":"HotChocolata likes this"
        }
      ]
    },
    "mediacount":1,
    "media":{
      "count":1,
      "data":[
        {
          "id":"m_18638",
          "shareable":1,
          "type":0,
          "when":"2012-01-26 21:51:54",
          "icon":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_m.jpg?18638",
          "icon_l":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_l.jpg?18638",
          "icon_b":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_b.jpg?18638",
          "full":"http:\/\/img.hipgeo.com\/4e79a36f452abc5d1abeb9c28e5baa75_d.jpg?18638",
          "height":"662",
          "width":"494"
        }
      ]
    }
  },
  "result":"success",
  "st":1333134901
} 
Error Code Possible Errors
401
  1. Authentication failed
  2. Token expired
  3. Insufficient Permission
  4. 'me' requires authentication
404
  1. ID not found
  2. Bad ID

PUT Journal Entry Object Example

PUT http://api.hipgeo.com/j_2343?access_token

Data:
{
    "privacy":0,
} 

Returns:
{
  "id":"j_15360",
  "result":"success"
} 
Error Code Possible Errors
400
  1. Unable to parse data
  2. Invalid journal permission
401
  1. Authentication failed
  2. Token expired
  3. Insufficient Permissions
404
  1. Bad ID
  2. ID not found
HipGeo Icon