Table of contents
Description
This method returns a list of places, which are located in a specified area.
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 > Facebook settings 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.getPlaces
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 | latitude | float | The decimal latitude of the user. |
| longitude | float | The decimal longitude of the user. | |
| Optional | query | string | A string to filter the search results. The string is typically a search term to be applied against places' names. For example: "coffee", "square". |
| radius | integer | The radius in meters to search. The default is 1000 meters. | |
| unifyResults | Boolean | Determines whether Gigya should unify the result data from the multiple providers. By default the value of this parameter is false (the data is not unified). Unifying results means that if the same place appears in the result data more then ones, coming from several providers, Gigya will unify the multiple entries into one entry with unified identifier. The unified identifier is the concatenation of the providers' specific IDs with "|" as separator. For example: Non unified data: places : [
{ID: "facebook:sdfd5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
{ID: "foursquare:12kui5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
{ID: "twitter:76rftg", name:"My other place", latitude:"32.2323", longitude:"34.234", distance:"541" }
] Unified data: places : [
{ID: "facebook:sdfd5|foursquare:12kui5", name:"Mike's Place", latitude:"23.2323", longitude:"43.234", distance:"145" },
{ID: "twitter:76rftg", name:"My other place", latitude:"32.2323", longitude:"34.234", distance:"541" }
] | |
| 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. | |
| format | string | Determines the format of the response. This parameter is required when using the REST API directly, and irrelevant when using one of our SDKs. The options are:
|
|
| callback | string | This parameter is relevant only when the format parameter is set to jsonp (see above). In such case 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. |
| places | Array | An array listing the places. Each place is represented by a JSON object. Each object contains the following fields:
|
| providerErrorCodes | Array | The result status of the operation per provider. Each provider result is represented by a JSON object, containing the following fields: provider, errorCode, errorMessage. |
Response Example
{
"places": [{
"ID": "facebook:205090946186458",
"name": "TRY Jesuss Ministries",
"latitude": 42.87818,
"longitude": -78.83985,
"distance": 293.6},
{
"ID": "twitter:a64f89e8250b7e5c",
"name": "Club Chit Chat",
"latitude": 42.878246,
"longitude": -78.835987,
"distance": 297.39},
{
"ID": "twitter:a307591cd0413588",
"name": "Buffalo",
"latitude": 42.826023,
"longitude": -78.956877,
"distance": 11176.89}
],
"statusCode": 200,
"errorCode": 0,
"statusReason": "OK",
"callId": "bf01d60d9bc0439b84653ce14b000e3a",
"providerErrorCodes": [{
"provider": "facebook",
"errorCode": 0,
"errorMessage": "OK"},
{
"provider": "twitter",
"errorCode": 0,
"errorMessage": "OK"}]
}
}
Comments