Was this article helpful?

socialize.checkin

Modified 09:03, 23 Apr 2013 by shirly

1. Description
1. 1.1. Supporting Providers
2. Request URL
3. Parameters
1. 3.1. Authorization Parameters
4. Response Data
5. Response Example

Description

This method "checks-in" the user to a specified place, on multiple social networks that support this feature.

Note: In Facebook and Twitter, checking-in is done via status update location parameters.

Supporting Providers

This operation is currently supported by the following providers: FourSquare, Facebook, Twitter.

Notes:
1. Before your application can check-in in Facebook, the user must grant your application an extended permission. Please make sure you have checked the "Enable checkin" check box in the Site Setup > Permissions page on Gigya's website. During the Social Login process, the user will be presented with a Facebook UI in which she can authorize your application to perform checkins on her behalf.
Please, read more in the Facebook Setting - Permissions guide.
2. In Twitter, the check-in operation is supported for users only if they choose so in their account settings. The user should check the "Add a location to your tweets" check-box in his Twitter account settings.

Request URL

http[s]://socialize.gigya.com/socialize.checkin

Parameters

Required	Name	Type	Description

Required*	UID	string	The unique ID of the user, with which this method call is associated. This is the UID you receive from Gigya after a successful login of this user. * The UID parameter is required when you call this method through one of the following interfaces: PHP SDK, Java SDK, NET SDK or if you are using the REST API directly with Gigya's proprietary authorization method. * The UID parameter is not required when you call this method through one of the following interfaces: Android SDK, iOS SDK or if you are using an external OAuth2 SDK. Note: If you are using account linking then the UID would be your site user ID. To learn more about Social Login with account linking (best practice), please refer to the Social Login Implementation guide.
Required	placeID	string	A unique identifier of the place to which to check-in. Note: you may receive a list of place identifiers using the socialize.getPlaces method.
	comment	string	A user comment associated with the check-in action.
Required*	latitude	float	The decimal latitude of the user. * The parameter is required by Facebook only.
	longitude	float	The decimal longitude of the user. * The parameter is required by Facebook only.
Optional	enabledProviders	string	A comma-delimited list of provider names to include in the method execution. This parameter gives the possibility to apply this method only to a subset of providers of your choice. If you do not set this parameter, by default all the providers are enabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply only to Facebook and Twitter, define: enabledProviders="facebook,twitter". Valid provider names include: 'facebook', 'twitter', 'foursquare'.
	disabledProviders	string	A comma-delimited list of provider names to exclude in the method execution. This parameter gives the possibility to specify providers to which that you don't want this method to apply. If you do not set this parameter, by default no provider is disabled (i.e. the method applies to all connected providers). For example, if you would like the method to apply to all providers except Google and Twitter, define: disabledProviders="google,twitter". Valid provider names include: 'facebook', 'twitter', 'foursquare'.
	cid	string	A string of maximum 100 characters length. This string will be associated with each transaction and will later appear on reports generated by Gigya, in the "Context ID" combo box. The cid allows you to associate the report information with your own internal data, for example, to identify a specific widget or page on your site/application. The "Context ID" combo box lets you filter the report data by site/application context.
	actionAttributes	JSON object	In Gamification your users receive points for actions they perform on your site, in this case checking in grants the user points. Action Attributes may be used to annotate actions with additional information, such as the section of the web site that generated the action. If you set here the actionAttributes, each time a user checks in, the action also receives an attribute, for example "tv-show":"glee", which can mean that the action was performed on the "Glee" page of the site. These action attributes are later used to display the GM Plugins filtered according to a certain attribute. For example, you can show the Leaderboard plugin only for top users on the "Glee" page. This parameter receives a JSON object, comprised of a set or sets of a key (category) and a value or values, i.e.: { "<attribute1 name>": ["<attribute1 value1>", "<attribute1 value2>", ...], "<attribute2 name>": "<attribute2 value>", ... } For example: { "tv-show": ["glee", "30rock"], "music": "pop" } In this example the action receives three attributes: {"tv-show":"glee"}, {"tv-show":"30rock"}, and {"music":"pop"}. This parameter may receive a list of up to three sets of key and value entries per call. If more values are entered, only the first three will count and the rest will be ignored. The three sets of key and value can be one key with three values, or three keys with one value each, or two keys, one with two values and the other with one value. You can also choose to input attributes using a generic "Tags" key, with no category name, for example: {"tags": ["glee", "house", "pop"]}. In this case the action receives these three attributes: {"tags":"glee"}, {"tags":"house"}, and {"tags":"pop"}.

	format	string	Determines the format of the response. The options are: json (default) jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
	callback	string	This parameter is relevant only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
	httpStatusCodes	Boolean	The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if occurs.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Note: the authorization parameters are required only if you are using the REST API directly. If you are using one of Gigya's SDKs then these parameters are not required, since the SDK implements the authorization method internally.

The set of required parameters is dependent on your selected method of authorization. There are two options:

If you are conforming with the OAuth 2.0 standard, you will need to Pass an Access Token. For more information, please read the Using Gigya's REST API in compliance with OAuth 2.0 guide.
If you are using Gigya's proprietary authorization method, you will need to pass the parameters specified here. Or, if you are making a call over HTTPS then you may pass the secret parameter instead of the timestamp, nonce and sig parameters. For more information, please read the Using Gigya's REST API with our proprietary authorization method guide.

Response Data

Field	Type	Description

errorCode	integer	The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage	string	A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails	string	This field will appear in the response only in case of an error and will contain the exception info, if available.
callId	string	Unique identifier of the transaction, for debugging purposes.
providerCheckinIDs	JSON Object	A JSON object containing a list of providers, each with its unique identifier of the checked-in place.

Response Example

{
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "81d94c4fa3764e75801637c608dbeb05",
        "providerCheckinIDs" :  {
              facebook: "123njhnj",
              foursquare: "kjf89yu8",
              twitter: "njbkjkl"
        }
}

Table of contents

socialize.checkin

Table of contents

Description

Supporting Providers

Request URL

Parameters

Authorization Parameters

Response Data

Response Example

Tags

Comments

Attachments

Table of contents