social.passports.foursquare.checkin

passports.social

Documentation

Foursquare/Swarm check-in metadata. Intended to be embedded within an app.beaconbits.beacon record as the 'foursquare' property, carrying fields that the beacon lexicon does not define — check-in ID, city, state, country, and photo. Consumers that only understand app.beaconbits.beacon will ignore this object.

main object

Foursquare/Swarm check-in metadata. Intended to be embedded within an app.beaconbits.beacon record as the 'foursquare' property, carrying fields that the beacon lexicon does not define — check-in ID, city, state, country, and photo. Consumers that only understand app.beaconbits.beacon will ignore this object.

Properties

checkinId string Required

Original Foursquare check-in ID. Used for deduplication and linking back to the source check-in.

maxLength: 64 bytes
photoUrl string uri Optional

URL to the check-in photo, if one was attached. Foursquare CDN URL in original size.

venueCity string Optional

City where the venue is located.

maxLength: 100 bytes
venueCountry string Optional

ISO 3166-1 alpha-2 country code, e.g. 'US'.

maxLength: 2 bytes
venueId string Required

Foursquare venue ID. Combined with the top-level venueUri, which is constructed as https://foursquare.com/venue/{venueId}.

maxLength: 64 bytes
venueState string Optional

State or region where the venue is located.

maxLength: 100 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "checkinId",
    "venueId"
  ],
  "properties": {
    "venueId": {
      "type": "string",
      "maxLength": 64,
      "description": "Foursquare venue ID. Combined with the top-level venueUri, which is constructed as https://foursquare.com/venue/{venueId}."
    },
    "photoUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL to the check-in photo, if one was attached. Foursquare CDN URL in original size."
    },
    "checkinId": {
      "type": "string",
      "maxLength": 64,
      "description": "Original Foursquare check-in ID. Used for deduplication and linking back to the source check-in."
    },
    "venueCity": {
      "type": "string",
      "maxLength": 100,
      "description": "City where the venue is located."
    },
    "venueState": {
      "type": "string",
      "maxLength": 100,
      "description": "State or region where the venue is located."
    },
    "venueCountry": {
      "type": "string",
      "maxLength": 2,
      "description": "ISO 3166-1 alpha-2 country code, e.g. 'US'."
    }
  },
  "description": "Foursquare/Swarm check-in metadata. Intended to be embedded within an app.beaconbits.beacon record as the 'foursquare' property, carrying fields that the beacon lexicon does not define — check-in ID, city, state, country, and photo. Consumers that only understand app.beaconbits.beacon will ignore this object."
}

Lexicon Garden

@