Check-Ins

The Check-Ins API provides access to Chatter, the user’s Check-Ins. The URI for listing contacts’ most recent check-ins will return the single, most recent check-in for the user’s contacts

Action Method URI
List Current User’s Check-Ins GET /check_in/my
List Chatter GET /check_in/chatter
List Contacts’ Most Recent Check-Ins* GET /check_in/contacts
Get Check-In GET /check_in/member/{id}
Create Check-In POST /check_in

List Check-Ins

These query parameters are available for listing Check-In objects. The URI for listing contacts’ most recent check-ins does not accept these parameters.

Parameter Details Default
comment_page Page number of records 1
limit Number of records to return 20

Top

Check-In Parameters (To Latitude/Longitude)

Parameter Example Details
check_in[mode] 1 Required, use value 1
check_in[center] -87.537549,34.862827 Required, {longitude},{latitude}
check_in[display_value] Killen, AL Name of location, HTML is not allowed

Top

Check-In Parameters (To Object)

Parameter Example Details
check_in[mode] 1 Required, use value 1
check_in[location_item][type] exhibitor Required, One of exhibitor, user, feature, event
check_in[location_item][id] 50 Required, Object’s ID
check_in[display_value] Hi! I’m here! Optional, Text-only (HTML is not allowed)
id 123 Optional, ID of user who is checking in
client_id 123 Optional, Client ID of user who is checking in

Top

Chatter Parameters

Parameter Example Details
check_in[mode] 2 Required, use value 2
check_in[location_item][type] event Optional*, One of event
check_in[location_item][id] 40 Optional*, Object’s ID
check_in[display_value] Hi all! Required,,Text-only (HTML is not allowed)
post_to_twitter 1 Optional*, use 1 to share status update on Twitter
post_to_facebook 1 Optional*, use 1 to share status update on Facebook

* If location_type and location_id are not provided, the location is assumed to be the conference. Also, if one of location_type or location_id is provided, both are required.
Top

JSON Response Example

{
  "id":294617606,
  "display_value":"At the hotel.  Time for bed.",
  "created_at":{
    "json_class":"Time",
    "s":1272736800,
    "n":0
  },
  "user":{
    "id":3,
    "first_name":"Charlie",
    "last_name":"Savage",
    "display_name":"Charlie",
    "account":{
      "id":3,
      "account_name":"cfis",
      "web_links":{
        "twitter":"http://twitter.com/cfis"
      },
      "addresses":[

      ],
      "type":"account"
    },
    "item":{
      "id":3,
      "display_value":"Charlie Savage",
      "created_on":{
        "json_class":"Time",
        "s":1313004007,
        "n":0
      },
      "updated_on":{
        "json_class":"Time",
        "s":1313004007,
        "n":0
      },
      "tags":[
        "Beer",
        "Maps"
      ],
      "icon":{
        "id":1082,
        "content_type":"image/png",
        "versions":{
          "small-32":"icon_1082_32.png",
          "small_hover-32":"icon_1082_32_hover.png",
          "medium-64":"icon_1082_64.png",
          "large-100":"icon_1082_100.png",
          "extra_large-150":"icon_1082_150.png",
          "logo-200":"icon_1082_200.png",
          "photo-640":"icon_1082_640.png"
        },
        "type":"icon"
      },
      "rating":null,
      "article":{
        "id":105283866,
        "item_id":3,
        "content":"<p>a list</p><p></p><p>of</p><p>several</p><p>things</p>",
        "type":"article"
      },
      "phones":[
        {
          "work_number":"123-456-7890",
          "fax_number":null,
          "cell_number":"098-765-4321",
          "type":"phone"
        }
      ],
      "type":"item"
    },
    "employee":{
      "position":"CEO",
      "company_name":"Zerista, Inc.",
      "type":"employee"
    },
    "type":"user"
  },
  "location":{
    "id":419,
    "name":"Hampton Inn, Florence, Alabama",
    "item":{
      "id":1012022029,
      "display_value":"Hampton Inn, Florence, Alabama",
      "created_on":{
        "json_class":"Time",
        "s":1272736800,
        "n":0
      },
      "updated_on":{
        "json_class":"Time",
        "s":1272736800,
        "n":0
      },
      "tags":[

      ],
      "icon":{
        "id":4,
        "content_type":"image/png",
        "versions":{
          "small-32":"icon_4_32.png",
          "small_hover-32":"icon_4_32_hover.png",
          "medium-64":"icon_4_64.png",
          "large-100":"icon_4_100.png",
          "extra_large-150":"icon_4_150.png",
          "logo-200":"icon_4_200.png",
          "photo-640":"icon_4_640.png"
        },
        "type":"icon"
      },
      "rating":null,
      "article":null,
      "phones":[

      ],
      "type":"item"
    },
    "names":[
      "Hampton Inn, Florence, Alabama"
    ],
    "geometries":[
      {
        "id":501,
        "geom":"0020000001000010E6C055EB0A137F38C5404165BF487FCB92",
        "type":"geometry"
      }
    ],
    "tags":[

    ],
    "creator":{
      "id":3,
      "account_name":"cfis",
      "web_links":{
        "twitter":"http://twitter.com/cfis"
      },
      "addresses":[

      ],
      "type":"account"
    },
    "permissions":{
      "insertable":true,
      "updatable":false,
      "deletable":false
    },
    "latlng":{
      "lat":34.7949,
      "lng":-87.67249
    },
    "type":"feature"
  },
  "mode":"check_in",
  "type":"check_in"
}

Top

XML Response Example

<?xml version="1.0" encoding="UTF-8"?>
<check-in>
  <id type="integer">294617606</id>
  <display-value>At the hotel.  Time for bed.</display-value>
  <created-at type="datetime">2010-05-01T18:00:00Z</created-at>
  <user>
    <id type="integer">3</id>
    <first-name>Charlie</first-name>
    <last-name>Savage</last-name>
    <display-name>Charlie</display-name>
    <account>
      <id type="integer">3</id>
      <account-name>cfis</account-name>
      <web-links>
        <twitter>http://twitter.com/cfis</twitter>
      </web-links>
      <addresses type="array"/>
    </account>
    <item>
      <id type="integer">3</id>
      <display-value>Charlie Savage</display-value>
      <created-on type="datetime">2011-08-10T19:20:07Z</created-on>
      <updated-on type="datetime">2011-08-10T19:20:07Z</updated-on>
      <tags type="array">
        <tag>Beer</tag>
        <tag>Maps</tag>
      </tags>
      <icon>
        <id type="integer">1082</id>
        <content-type>image/png</content-type>
        <versions>
          <small-32>icon_1082_32.png</small-32>
          <small-hover-32>icon_1082_32_hover.png</small-hover-32>
          <medium-64>icon_1082_64.png</medium-64>
          <large-100>icon_1082_100.png</large-100>
          <extra-large-150>icon_1082_150.png</extra-large-150>
          <logo-200>icon_1082_200.png</logo-200>
          <photo-640>icon_1082_640.png</photo-640>
        </versions>
      </icon>
      <rating nil="true"></rating>
      <article>
        <id type="integer">105283866</id>
        <item-id type="integer">3</item-id>
        <content>&lt;p&gt;a list&lt;/p&gt;&lt;p&gt;&lt;/p&gt;&lt;p&gt;of&lt;/p&gt;&lt;p&gt;several&lt;/p&gt;&lt;p&gt;things&lt;/p&gt;</content>
      </article>
      <phones type="array">
        <phone>
          <work-number>123-456-7890</work-number>
          <fax-number nil="true"></fax-number>
          <cell-number>098-765-4321</cell-number>
        </phone>
      </phones>
    </item>
    <employee>
      <position>CEO</position>
      <company-name>Zerista, Inc.</company-name>
    </employee>
  </user>
  <location>
    <id type="integer">419</id>
    <name>Hampton Inn, Florence, Alabama</name>
    <item>
      <id type="integer">1012022029</id>
      <display-value>Hampton Inn, Florence, Alabama</display-value>
      <created-on type="datetime">2010-05-01T18:00:00Z</created-on>
      <updated-on type="datetime">2010-05-01T18:00:00Z</updated-on>
      <tags type="array"/>
      <icon>
        <id type="integer">4</id>
        <content-type>image/png</content-type>
        <versions>
          <small-32>icon_4_32.png</small-32>
          <small-hover-32>icon_4_32_hover.png</small-hover-32>
          <medium-64>icon_4_64.png</medium-64>
          <large-100>icon_4_100.png</large-100>
          <extra-large-150>icon_4_150.png</extra-large-150>
          <logo-200>icon_4_200.png</logo-200>
          <photo-640>icon_4_640.png</photo-640>
        </versions>
      </icon>
      <rating nil="true"></rating>
      <article nil="true"></article>
      <phones type="array"/>
    </item>
    <names type="array">
      <name>Hampton Inn, Florence, Alabama</name>
    </names>
    <geometries type="array">
      <geometry>
        <id type="integer">501</id>
        <geom>0020000001000010E6C055EB0A137F38C5404165BF487FCB92</geom>
      </geometry>
    </geometries>
    <tags type="array"/>
    <creator>
      <id type="integer">3</id>
      <account-name>cfis</account-name>
      <web-links>
        <twitter>http://twitter.com/cfis</twitter>
      </web-links>
      <addresses type="array"/>
    </creator>
    <permissions>
      <insertable type="boolean">true</insertable>
      <updatable type="boolean">false</updatable>
      <deletable type="boolean">false</deletable>
    </permissions>
    <latlng>
      <lat type="float">34.7949</lat>
      <lng type="float">-87.67249</lng>
    </latlng>
  </location>
  <mode>check_in</mode>
</check-in>

Top

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s