">mixi Developer Center (mDC)

mixi Connect

mixi Connect (English) » mixi Graph API » Technical Specification » Check-in API

Check-in API

mixi Check-in is a communication function that uses the GPS feature of a mobile phone to easily share your current location or shops (spot) you visit with your friends or acquaintances.

You can check in at a spot already registered, such as Shibuya Station or Chuuken Hachi-kou (loyal dog Hachi) or you can also create a new spot (My spot) that you wish to exclusively share with your friends. In addition, the feedback features, such as comments or "Like," enable you to enjoy smooth communication by commenting or "liking" the places or shops that your friends check in.

Using the Check-in API enables you to view the check-in list of specific users (including your friends), check a desired spot, add comments, and use Like.

This document explains how to use the Check-in API.

※When searching spots in the vicinity, only "My spots" can be found.

Common Specifications

Prerequisites

To use the Check-in API, you are required to have the following information beforehand.

  • An access token authorized for either or both the "r_checkin" and "w_checkin" scopes

You can only access the Check-in API with an authorized access token mentioned above. For details on how to obtain an access token, see the page on the "procedures for authorization".

Functions provided by the Check-in API and the necessary scope

The various functions provided by the Check-in API fall into the following two major groups: reference system and posting system. This classification directly corresponds to the scopes for using the Check-in API. The following shows the scopes and corresponding functions:

Scope Functions
r_checkin Obtaining a spot
Searching for My spots in the vicinity
Obtaining the list of My spots
Obtaining check-in feed
Obtaining a check-in
Obtaining the list of comments on a check-in
Obtaining the list of Likes for a check-in
w_checkin Creating a My spot
Deleting a My spot
Checking in a spot
Deleting a check-in
Posting a comment on a check-in
Deleting a comment on a check-in
Posting Like for a check-in
Deleting Like for a check-in

Positional Information

Positional information is expressed as decimal numbers. The geodetic system is based on WGS84.

Values that can be specified for the fields parameter

An API for the reference system supports the fields parameter. In the field parameter, fields to be acquired are separated by commas (","). If a field is an object, a dot can be used to specify the field. For example, specifying user.id indicates that the user field includes the id field.

  • If @all is specified in the fields parameter, all fields are included.
  • If the fields parameter is omitted, the required or optional field for each object is included.
  • If the fields parameter is specified, the required field for each object and a specified field are included.

(Example) When specifying fields=name,address.geohash for obtaining a spot

{
  "id": "S100",
  "name": {
    "formatted": "Coffee specialized shop  Ginza 3-chome branch"
  },
  "address": {
    "latitude": "37.416343",
    "longitude": "-122.153013",
    "geohash": "abc7h36zwv4g"
  }
}
  • The id field is included because it is required.
  • The name field is included because it is specified with the fields parameter.
  • The address.geohash field is included because address.geohash is specified with the fields parameter.
  • The address.latitude and address.longitude fields are included because they are required.

Handling pictograms

The check-in and the comment-posting functions also support the posting of a pictogram. For these APIs, emojiCarrier or emojiCharset that are common for Graph APIs can be specified. For details, see "Handling Pictograms" in the API Common Specifications.

How to specify paging using sinceId and resultsDirection

Specify paging with the following parameter for an API when searching for a spot and obtaining a check-in field.

Parameter name Description
sinceId Specifies an ID that indicates the basing point of results obtained.
resultsDirection For recent, the results between the latest and one in the location specified with sinceId (*1) are obtained.
For next, the result in the place specified with sinceId and ones before the location in the sort order are obtained (*1)
count Maximum number of results obtained

(*1) The element in the location specified with sinceId is not included. The number of elements returned does not surpass the count amount.

  • The result does not include totalResults or startIndex.
  • The default of resultsDirection is "recent" for the check-in field and "next" for spot search.

Common error specification

If processing has not been performed normally, the system returns any of the following errors. The response body of an error is an object in the JSON format, so the error type can be identified with the value of the error field.

Situation Status code Value of error field Supplemental
The format of the request does not comply with the specification. 400 (Bad Request) parameter_invalid The parameter name that caused the error is stored in the parameters_invalid field.
Some required parameters are missing. 400 (Bad Request) parameter_absent The parameter name missing is stored in the parameters_absent field.
Capacity or available number is exceeded. 403 (Forbidden) parameter_over_capacity This error will be returned if the maximum number has been reached when creating "my spot"
Contents are inaccessible 403 (Forbidden) permission_denied
No target content or target user is found. 404 (Not Found) not_found

For example, a response body similar to the following is returned:

{
    "error": "parameter_invalid",
    "parameters_invalid": "fields,center",
    "error_description": "Invalid parameters found"
}

Object

This section describes the specifications of each object included in a request or a response of API.

Spot/My spot (Spot)
Field name Type Details Required/Optional Example
id String ID common to a spot and My spot Required "S100″, "M100″
name Name Name of a spot Optional (Separately mentioned)
description String Freely written description Optional "This is a coffee specialized shop."
owner User Spot administrator Optional (Separately mentioned)
categories Array<Category> Category Optional (Separately mentioned)
address Address Address Optional (Separately mentioned)
{
  "id": "S100",
  "name": {
    "formatted": "Coffee specialized shop Ginza 3-chome branch"
  },
  "address": {
    "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo, 104-0061"
    "latitude": "37.416343",
    "longitude": "-122.153013",
    "geohash" : "abc7h36zwv4g",
    "distance": "3.112593239511196"
  },
  "categories": [ { "formatted": "Restaurant business" } ],
  "description": "Shop description written here"
}
Check-in history (Check-in)
Field name Type Details Required/Optional Example
id String ID of Check-in history Required "1FZ3P4ACUWBBC-2010061010321″
user User User who checked in Optional (Separately mentioned)
message String Message Optional "Second floor at Ginza 3-chome branch"
spot Spot Target spot Optional (Separately mentioned)
location Location Location Optional (Separately mentioned)
numComments String Number of comments Optional "3″
numFavorites String Number of "Likes" Optional "3″
comments Array<Comment> Latest comment (*1) Specified (Separately mentioned)
favorites Array<User> User who most recently posted "Like" (*1) Specified (Separately mentioned)
favorited Boolean For an authorized user who has posted "Like", {{true}}; otherwise {{false}} Optional true
photo Array<Photo> Photo posted (*3) Specified (Separately mentioned)
created String Creation date and time Optional "2010-11-02T10:42:57+09:00″ (W3C-DTF) (※2)

(*1) The latest several items only can be obtained by the latest comment/"Like" of each check-in history. In addition, some API may limit the number due to the restriction imposed when providing a service.
(*2)For details on W3C-DTF, which is the notation of date and time, see Note on W3C.
(*3) In the event "photo" is specified in the fields, the link to the photo can be extracted from the check-in text

{
  "id": "1FZ3P4ACUWBBC-2010061010321",
  "user": {
    "id" : "1FZ3P4ACUWBB",
    "displayName" : "Becky",
    "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
    "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
  },
  "message": "There are the coffee bar counter and exhibition space displaying artworks on the second floor.",
  "spot": {
    "id": "S100",
    "name": {
      "formatted": "Coffee specialized shop  Ginza 3-chome branch"
    },
    "address": {
      "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo, 104-0061"
    },
    "location": {
      "latitude": "37.416343",
      "longitude": "-122.153013"
      "geohash" : "abc7h36zwv4g",
    }
  },
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "numComments": "3",
  "numFavorites": "5",
  "comments": [ ... ]
  "favorites": [ ... ],
  "favorited": false,
  "created" : "2010-11-02T10:42:57+09:00",
  "photo" : [
    {
      "albumId": "99465",
      "created": "2010-11-01T12:04:49+09:00",
      "exifCreated": "2010-11-01T11:34:35+09:00",
      "id": "117676",
      "largeImageUrl": "http://ic.photo.mixi.jp/v/fffd76a06cf4275c267257b96eb1c2c3c06bf8e25b/4cd21765/picture/u7dshdjk3mbc4x_117676_65xga.jpg",
      "mimeType": "image/jpeg",
      "numComments": "0",
      "numFavorites": "0",
      "thumbnailUrl": "http://ic.photo.mixi.jp/v/8684fa2911a044f9de932f6ee7f00f5d46ade867c8/4cd21765/picture/u7dshdjk3mbc4x_117676_65small.jpg",
      "title": "ふぁー",
      "type": "IMAGE",
      "url": "http://ic.photo.mixi.jp/v/8e0e2ab248dc82fe8bf016d7bb361f6117ab0cec5f/4cd21765/picture/u7dshdjk3mbc4x_117676_65large.jpg",
      "viewPageUrl": "http://mixi.jp/redirect_with_owner_id.pl?b=http%3A%2F%2Fphoto.mixi.jp%3A8150%2Fview_photo.pl%3Fphoto_id%3D117676&k=owner_id&v=7dshdjk3mbc4x"
    }
  ]
}
Comment object (Comment)
Field name Type Details Required/Optional Example
id String ID of a comment Required "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emdd-20101208110507″
user User User who commented Optional (Separately mentioned)
text String Message Optional "Comment body"
created String Creation date and time Optional "2010-11-02T10:42:57+09:00″ (W3C-DTF) (※2)

(※2) For details on W3C-DTF, which is the notation of date and time, seeNote on W3C.

Name object (Name)
Field name Type Details Required/Optional Example
formatted String Name Required "コCoffee specialized shop Ginza 3-chome branch"

Category object (Category)

The Category object has the same fields as the Name object.

Location object (Location)

Field name Type Details Required/Optional Example
latitude String Latitude, expressed as DEG (decimal) Required "37.416343″
longitude String Longitude, expressed as DEG (decimal) Required "-122.153013″
geohash String Geohash Optional "abc7h36zwv4g"
distance String Distance (meter) (*1) Optionl "3.112593239511196″

(*1) This can be obtained only if a reference coordinate is given for spot search or other processing.

Address object (Address)

The Address object has the following field in addition to the fields for the Location object:

Field name Type Details Required/Optional Example
formatted String Address (all) Optional "7-1 Ginza 3-chome, Chuo-ku, Tokyo 104-0061"
User object (User)
Field name Type Details Required/Optional Example
id String User-ID Required "1FZ3P4ACUWBBC"
displayName String Nickname Required "mixi official"
thumbnailUrl String Image of a thumbnail Optional "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg"
profileUrl String URI of a profile page Optional "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
Publication range object (Privacy)
Field name Type Details Required/Optional Example
visibility String Character string indicating the publication range Required (Separately mentioned)
group String If visibility is group, specify the group ID of the publication destination. (*1) Optional "3″

(*1) For the group ID, specify an ID obtained by Groups API.

The following publication ranges can be specified for visibility:

Specification Meaning
friends Make public to your friends
friends_of_friends Make public to the friends of your friends
top_friends Make public to your close friends
group Make public to a specific group
self Remain private

(Example 1) Make public to your friends

{
    "visibility": "friends"
}

(Example 2) Make public to a specific group

{
    "visibility": "group",
    "group": "3"
}
Photo Object (Photo)
Field name Type Details Required/Optional Example
id String ID to identify photo Required "117676"
albumId String Album ID (The ID for the "Easy public album" is "@default" Optional "@default"
created String The time and date in which the photo was uploaded Optional "2010-11-02T10:42:57+09:00" (W3C-DTF) (※1)
mimeType String MIME type of the photo Optional "image/jpeg"
type String "IMAGE" Optional "IMAGE"
url String The URL of a larger version of the photo Optional -
thumbnailUrl String The URL of the thumbnail version of the photo Optional -
largeImageUrl String The URL for the XGA sized photo Optional -
viewPageUrl String The URL of the photo page Optional -
numComments String The number of comments that were posted to the photo数 Optional "3"
numFavorites String The number of "likes" that were posted to the photo Optional "3"
exifCreated String The date in which the photo was taken Optional "2010-11-02T10:42:57+09:00" (W3C-DTF) (*1)

(*1) For information regarding the date and time method, W3C-DTF, please refer to ([W3C Notes|http://www.w3.org/TR/NOTE-datetime])

List of Functions (related to spot)

The spot-related functions provided by the Check-in API are as follows:

  • Obtaining a spot
  • Searching for My spots in the vicinity
  • Obtaining the list of My spots
  • Creating a My spot
  • Deleting a My spot

Obtaining a spot

Request specification

The URI to obtain a spot is as follows:

GET https://api.mixi-platform.com/2/spots/[Spot-ID]

The parameter included in the URI is as follows:

Parameter name Value to be specified
Spot-ID ID of a spot

This URI accepts the following query parameter:

Parameter name Description Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional

Response specification

The result of a spot obtained is as follows. The information included in each entry is a spot object.

<Example>

{
    "id": "S100",
    "name": {
        "formatted": "Coffee specialized shop  Ginza 3-chome branch"
    },
    "address": {
        "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo 104-0061"
    },
    "location": {
        "latitude": "37.416343",
        "longitude": "-122.153013"
    },
    "description": "Shop description written here"
}

* As for "My spot", you can obtain only the "My spots" of your friends.

Searching for My spots in the vicinity

Request specification

The URI to search for "My spots" in the vicinity is as follows:

GET https://api.mixi-platform.com/2/search/spots

This URI accepts the following query parameters:

Parameter name Description Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional
center Specify the center point of the search range as latitude, longitude, delimited by a comma. (*1) Required
q Search string for keyword search (*2) Optional
sinceId Specify Spot-ID that is the base point when obtaining results. (*3) Optional
resultsDirection Specify a range of results to be obtained using sinceId as the base point (*3) Optional "next"
count Specify the maximum number of spots to be obtained as a result. Optional 20

(*1) The latitude and longitude can be specified in either DMS (Degrees/Minutes/Seconds) or DEG (Decimal degrees) format.
(*2) Specify a URI-encoded character string that has already been encoded in UTF-8.
(*3) For details, see "How to specify paging using sinceId and resultsDirection" described in another section.

Response specification

The result of My spots obtained is as follows. The information included in each entry is a spot object.
The results are sorted in ascending order of the distance from the coordinate (center) specified when the request was made.

{
    "startIndex": 0,
    "itemsPerPage": 10,
    "totalResults: 50,
    "entry": [
        {
            "id": "S100",
            "name": {
                "formatted": "Coffee specialized shop  Ginza 3-chome branch"
            },
            "address": {
                "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo 104-0061"
            },
            "location": {
                "latitude": "37.416343",
                "longitude": "-122.153013"
            },
            "description": "Shop description written here"
        },
        ...
    ]
}

Obtaining the list of "My spots"

Request specification

The URI to obtain the list of "My spots" is as follows:

GET https://api.mixi-platform.com/2/spots/[User-ID]/@self

The parameter included in the URI path is as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, "@me" indicating an authorized user him/herself, or the user ID of a friend

This URL accepts the following query parameters:

Parameter name Description Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional
startIndex Start index Optional 0
count Number of spots obtained Optional 20

Response specification

The result of spots obtained is as follows. The information included in each entry is a spot object. The results are sorted in descending order based on the time updated.

{
   "entry" : [
      {
         "owner" : {
            "thumbnailUrl" : "http://profile.img.mixi.jp/user/cdt9kxyucqnnd_3557510163.jpg",
            "id" : "cdt9kxyucqnnd",
            "displayName" : "Test name",
            "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
         },
         "name" : {
            "formatted" : "Normal spot name"
         },
         "address" : {
            "longitude" : "+139.7660838889",
            "latitude" : "+35.6813819444",
            "geohash" : "xn76urwe1g9w"
         },
         "id" : "M296",
         "description" : "It is a normal spot.[i:3]"
      }
   ],
   "startIndex" : 0,
   "itemsPerPage" : 20,
   "totalResults" : 1
}

* As for a My spot, you can obtain only the "My spots" of your friends.

Creating a "My spot"

Request specification

The URI to create "My spot" is as follows:

POST https://api.mixi-platform.com/2/spots/[User-ID]/@self

The parameter included in the URI path is as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, "@me" indicating an authorized user him/herself

Specify "application/json" in the Content-Type request header, and send the following details in the JSON format included in the request body.
For character encoding, specify UTF-8 or another encoding in charset in the Content-Type request header. Note that emojiCarrier or emojiCharset, if already specified, is given priority.

Field name Type Details Required/Optional Default
name String Name of "My spot" Required
location Location Location Required
description String Description of "My spot" Optional ""

<Example>

{
    "name": "My spot",
    "location" : {
        "latitude" : "+139.7660838889",
        "longitude" : "+35.6813819444",
    },
    "description" : "This is My spot."
}

Response specification

If a "My spot" has been successfully created, the HTTP status code 201 is returned.
The response body is in JSON which includes the following details:

Field name Type Details Required/Optional Default Example
id String ID of "My spot" Required "M296″

<Example>

{
    "id": "M296"
}

Deleting a "My spot"

Request specification

The URI to delete "My spot" is as follows:

DELETE https://api.mixi-platform.com/2/spots/[User-ID]/@self/[Spot-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user or "@me" indicating an authorized user him/herself
Spot-ID ID of the target "My spot"

Response specification

If a "My spot" has been successfully deleted, the HTTP status code 200 is returned.

HTTP/1.1 200 OK

List of Functions (related to check-in)

Obtaining check-in feed

Request specification

The URI to obtain check-in feed is as follows:

GET https://api.mixi-platform.com/2/checkins/[User-ID]/[Group-ID]

The parameters included in the URL path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, "@me" indicating an authorized user him/herself, or the user ID of a friend
Group-ID ID to specify a set of users that feed the list to be obtained (group ID or @self, @friends, @topFriends) (*1)

(*1) For an ID other than the ID of the user for whom User-ID authorized the access token, the @self only can be specified for Group-ID.

This URI accepts the following query parameters:

Field name Details Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional
spotId Obtain check-in feed of the spot pointed by this ID. Optional
center Specify the center point of the search range as latitude, longitude, delimited by a comma. Optional (※2)
sinceId Specify the ID of check-in that is the base point when obtaining results. (*3) Optional
resultsDirection Specify a range of results to be obtained using sinceId as the base point. (*3) Optional "recent"
count Specify the maximum number of spots to be obtained as a result. (*1) Optional 20

(*1) The actual number of spots obtained may be less than the specified value.
(*2) Spot-ID, if already specified, is given priority.
(*3) For details, see "How to specify paging using sinceId and resultsDirection" described in another section.

Response specification

The result of check-in feed obtained is shown as follows. The information included in each entry is a check-in history object.
The results are sorted in descending order of the creation time and date.

{
    "itemsPerPage": 20,
    "entry": [
        {
          "id": "1FZ3P4ACUWBBC-2010061010321",
          "user": {
            "id" : "1FZ3P4ACUWBB",
            "displayName" : "Becky",
            "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
            "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
          },
          "message": "On the second floor in the Ginza 3-chome branch, there are coffee bar counter and exhibition space displaying artworks.",
          "spot": {
            "id": "S100",
            "name": {
              "formatted": "Coffee specialized shop  Ginza 3-chome branch"
            },
            "address": {
              "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo, 104-0061"
            },
            "location": {
              "latitude": "37.416343",
              "longitude": "-122.153013"
            }
          },
          "location": {
            "latitude": "37.416343",
            "longitude": "-122.153013"
          },
          "numComments": "3",
          "numFavorites": "5",
          "favorited": false,
          "created" : "2010-11-02T10:42:57+09:00"
        },
        ...
    ]
}

* startIndex and totalResult are not included in a response.
* The favorites and the comments fields have restriction on the period or the number of values returned. Because of this, not all the results for any feed are always returned. Usually, several latest results are returned for each feed for the past several months.

Obtaining a check-in

Request specification

The URI to obtain a check-in is as follows:

GET https://api.mixi-platform.com/2/checkins/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, @me indicating an authorized user him/herself, or the user ID of a friend
Checkin-ID ID to specify check-in to be obtained

This URI accepts the following query parameter:

Field name Details Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional

Response specification

The result of check-in obtained is shown as follows. The information included is a check-in history object.

{
  "id": "1FZ3P4ACUWBBC-2010061010321",
  "user": {
    "id" : "1FZ3P4ACUWBB",
    "displayName" : "Becky",
    "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
    "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
  },
  "message": "On the second floor in the Ginza 3-chome branch, there are coffee bar counter and exhibition space displaying artworks.",
  "spot": {
    "id": "S100",
    "name": {
      "formatted": "Coffee specialized shop  Ginza 3-chome branch"
    },
    "address": {
      "formatted": "7-1 Ginza 3-chome, Chuo-ku, Tokyo, 104-0061"
    },
    "location": {
      "latitude": "37.416343",
      "longitude": "-122.153013"
    }
  },
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "numComments": "3",
  "numFavorites": "5",
  "favorited": false,
  "created" : "2010-11-02T10:42:57+09:00"
}

Checking in a spot

Request specification

The URI to check in a spot is as follows:

POST https://api.mixi-platform.com/2/checkins/[Spot-ID]

The parameter included in the URI path is as follows:

Parameter name Value to be specified
Spot-ID ID of a spot where you check in

The following are two ways in which to specify the request body. In order to post a check-in with a photo you must use the "multipart/form-data" format.

"application/json"

Specify "application/json" in the Content-Type request header, and send the following details in the JSON format included in a request body.
For character encoding, specify UTF-8 or another encoding in charset in the Content-Type request header. Note that emojiCarrier or emojiCharset, if already specified, is given priority.

Field name Type Details Required/Optional Default
location Location Location information of check-in Optional (Location of specified spot)
message String Body of check-in Optional ""
privacy Privacy Specify a publication range for this posting Optional (Make public to your friends)

<Example>

{
    "message": "I will check in.",
    "location": {
        "latitude": "37.416343",
        "longitude": "-122.153013"
    },
    "privacy" : {
        "visibility" : "friends_of_friends",
    }
}

"multipart/form-data"

Specify the "multipart/form-data" in the Content-Type request header and specify the following parameters in the request body.

Field name Type Details Required/Optional Default
request String JSON text that can be specified for application/JSON Required (mentioned above)
photo Bytes Binary data of photos Optional -
boundary text
Content-Disposition: form-data; name="request"

{
  "message": "I will check in",
  "location": {
    "latitude": "37.416343",
    "longitude": "-122.153013"
  },
  "privacy" : {
    "visibility" : "friends_of_friends",
  }
}
boundary text
Content-Disposition: form-data; name="photo"; filename="picture.jpg"
Content-Type: image/jpeg

.......binary data for the photo

Response specification

If a "My spot" has been successfully created, the HTTP status code 201 is returned. The response body is in JSON which includes the following details.

Field name Type Details Required/Optional Default Example
id String ID of check-in Required "1FZ3P4ACUWBBC-2010061010321″
{
    "id": "1FZ3P4ACUWBBC-2010061010321"
}

Deleting a check-in

Request specification

The URI to delete a check-in is as follows:

DELETE https://api.mixi-platform.com/2/checkins/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, "@me" indicating an authorized user him/herself
Checkin-ID ID of a target check-in

Response specification

If a check-in has been successfully deleted, the HTTP status code 200 is returned.

HTTP/1.1 200 OK

List of Functions (comment/Like)

Obtaining the list of comments on a check-in

Request specification

The URI to obtain a list of comments on a check-in is as follows:

GET https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, @me indicating an authorized user him/herself, or user ID of a friend
Checkin-ID ID of a target check-in

This URI accepts the following query parameters:

Field name Details Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional
startIndex Start index Optional 0
count Number of comments obtained Optional 20

Response specification

The result of comments obtained is shown as follows. The information included in each entry is the comment object.

{
    "startIndex": 0,
    "itemsPerPage": 20,
    "totalResults: 1,
    "entry": [
        {
            "id": "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emdd-20101208110507",
            "created" : "2010-12-08T11:07:38+09:00",
            "text" : "This is a comment.",
            "user": {
                "id" : "1FZ3P4ACUWBB",
                "displayName" : "Becky",
                "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
                "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx"
            }
        }
    ]
}

About a user posting a comment

If a user posting a comment is not a friend of an authorized user, then only the user.id and user.displayName are returned.

Posting a comment on a check-in

Request specification

The URI to post a comment is as follows:

POST https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, @me indicating an authorized user him/herself, or user ID of a friend
Checkin-ID ID of a target check-in

Specify "application/json" in the Content-Type request header, and send the following details in the JSON format included in a request body.
For character encoding, specify UTF-8 or another encoding in charset in the Content-Type request header. Note that emojiCarrier or emojiCharset, if already specified, is given priority.

Field name Type Details Required/Optional Default
text String Body of a comment Required

<Example>

{
    "text" : "This is a comment."
}

Response specification

If a comment has been successfully posted, the HTTP status code 201 is returned. The response body is in JSON which includes the following details:

Field name Type Details Required/Optional Default Example
id String ID of a comment Required "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emde-20101208110400″

<例>

{
    "id": "sa1pzkdg9emdd-500000004743798-sa1pzkdg9emde-20101208110400"
}

Deleting a comment on a check-in

Request specification

The URI to delete a comment is as follows:

DELETE https://api.mixi-platform.com/2/checkins/comments/[User-ID]/@self/[Checkin-ID]/[Comment-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, @me indicating an authorized user him/herself, or user ID of a friend
Checkin-ID ID of a target check-in
Comment-ID ID of a comment to be deleted

Response specification

If a comment has been successfully deleted, the HTTP status code 200 is returned.

HTTP/1.1 200 OK

Obtaining the list of "Likes" for a check-in

Request specification

The URI to obtain a list of "Likes" for a check-in is as follows:

GET https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of an authorized user, @me indicating an authorized user him/herself, or user ID of a friend
Checkin-ID ID of a target check-in

This URI accepts the following query parameters:

Field name Details Required/Optional Default
fields Specify comma-delimited items for which information is to be obtained. Optional
startIndex Start index Optional 0
count Number of comments obtained Optional 20

Response specification

The result of a list of "Likes" obtained is shown as follows. The information included in each entry is a Like object.

{
    "startIndex": 0,
    "itemsPerPage": 20,
    "totalResults: 1,
    "entry": [
        {
            "id" : "1FZ3P4ACUWBB",
            "displayName" : "Becky",
            "thumbnailUrl" : "http://profile.img.mixi.jp/photo/user/1FZ3P4ACUWBBC_301280930.jpg",
            "profileUrl" : "http://mixi.jp/redirect_friend_api.pl?puid=xxxxxxxxxxxxx&client_id=xxxxxxxx",
            "created" : "2010-11-02T10:42:57+09:00"
        }
    ]
}

About a user posting "Like"

If a user posting "Like" is not a friend of an authorized user, then only the user.id and user.displayName are returned.

Posting Like for a check-in

Request specification

The URI to post Like is as follows:

POST https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]

The parameters included in the URI path are as follows:

Parameter name Value to be specified
User-ID User ID of a friend of an authorized user
Checkin-ID ID of a target check-in

Response specification
If Like has been successfully posted, the HTTP status code 201 is returned.
The response body is in JSON which includes the following details:

Field name Type Details Required/Optional Default Example
id String ID of a user posting Like Required "sa1pzkdg9emdd"

<Example>

{
    "id": "sa1pzkdg9emdd"
}

Deleting Like for a check-in

Request specification

The URI to delete Like is as follows:

DELETE https://api.mixi-platform.com/2/checkins/favorites/[User-ID]/@self/[Checkin-ID]/[Favorite-User-ID]
Parameter name Value to be specified
User-ID User ID of a friend of an authorized user
Checkin-ID ID of a target check-in
Favorite-User-ID ID of "Like" to be deleted

Response specification

If a "Like" has been successfully deleted, the HTTP status code 200 is returned.

HTTP/1.1 200 OK

TOP OF THIS PAGE