VinPass API – Passes

IMPORTANT: this version of the Passes API is deprecated. Although this version is still operational, please use the latest version for all new development.

This page is related to the VinPass API.

The VinPass Passes entry point allows you to retrieve details on all of the available passes, contextually matched to a player on your platform.

URL: http://api.vinpass.com/v1/passes
Method: GET
Version: 1

Request Parameters

Name Required? Description
user Yes User identifier (from your system) that is used as the user.id field when submitting activities to VinPass.

Response Format

Responses will have the following format, with an array of passes for each category. All responses will be in UTF-8.

Field Name Type Description
regionPasses Array Array of passes in the region category.
regionPasses.passId String Unique identifier for this pass.
regionPasses.passType Enum Game play type for pass: PROGRESSIVE or CHECK_LIST.
regionPasses.lastActivityDate Datetime Timestamp of last activity against this pass for this user (ISO 8601).
regionPasses.earned Boolean Indicator if this pass has been earned for this user.
regionPasses.earnedDate Datetime Timestamp when this pass was earned (ISO 8601).
regionPasses.inPlay Boolean Indicator if this pass in-play (i.e. started but not yet earned) for this user.
regionPasses.name String Name for this pass
regionPasses.description String Name for this pass
regionPasses.imageUrl URL URL to pass image URL
regionPasses.sponsor.name String Name of the sponsor for this pass.
regionPasses.sponsor.description String Description of the sponsor for this pass.
regionPasses.sponsor.url URL URL for the sponsor.
regionPasses.sponsor.logoUrl URL URL for the sponsor logo image.
varietalPasses Array Array of passes in the varietal category.
varietalPasses.passId String Unique identifier for this pass.
varietalPasses.passType Enum Game play type for pass: PROGRESSIVE or CHECK_LIST.
varietalPasses.lastActivityDate Datetime Timestamp of last activity against this pass for this user (ISO 8601).
varietalPasses.earned Boolean Indicator if this pass has been earned for this user.
varietalPasses.earnedDate Datetime Timestamp when this pass was earned (ISO 8601).
varietalPasses.inPlay Boolean Indicator if this pass in-play (i.e. started but not yet earned) for this user.
varietalPasses.name String Name for this pass
varietalPasses.description String Name for this pass
varietalPasses.imageUrl URL URL to pass image URL
varietalPasses.sponsor.name String Name of the sponsor for this pass.
varietalPasses.sponsor.description String Description of the sponsor for this pass.
varietalPasses.sponsor.url URL URL for the sponsor.
varietalPasses.sponsor.logoUrl URL URL for the sponsor logo image.
brandPasses Array Array of passes in the brand category.
brandPasses.passId String Unique identifier for this pass.
brandPasses.passType Enum Game play type for pass: PROGRESSIVE or CHECK_LIST.
brandPasses.lastActivityDate Datetime Timestamp of last activity against this pass for this user (ISO 8601).
brandPasses.earned Boolean Indicator if this pass has been earned for this user.
brandPasses.earnedDate Datetime Timestamp when this pass was earned (ISO 8601).
brandPasses.inPlay Boolean Indicator if this pass in-play (i.e. started but not yet earned) for this user.
brandPasses.name String Name for this pass
brandPasses.description String Name for this pass
brandPasses.imageUrl URL URL to pass image URL
brandPasses.sponsor.name String Name of the sponsor for this pass.
brandPasses.sponsor.description String Description of the sponsor for this pass.
brandPasses.sponsor.url URL URL for the sponsor.
brandPasses.sponsor.logoUrl URL URL for the sponsor logo image.

Example

{
  "regionPasses": [
    {
        "passId": "4444-1111",
        "passType": "CHECK_LIST",
        "lastActivityDate": "2010-12-26T10:22:56Z",
        "earnedDate": "2010-12-26T10:22:56Z",
        "earned": true,
        "inPlay": false,
        "name": "Bank On It",
        "description": "Taste a wine from each of the regions from the left and right banks of Bordeaux",
        "imageUrl" : "http://assets.vinpass.com/passes/4444-1111-earned.jpg",
        "sponsor": {
          "name": "Fictitious Bordeaux Society",
          "description": "Collection of Bordeaux experts..."
        }
      },
      {
        "passId": "2255-1111",
        "passType": "PROGRESSIVE",
        "earned": false,
        "inPlay": false,
        "name": "Welcome to Napa Valley",
        "description": "We're pleased to welcome you to exploring more about Napa Valley and our...",
        "imageUrl" : "http://assets.vinpass.com/passes/2255-1111-inplay.jpg",
        "sponsor": {
          "name": "Napa Valley Fake Consortium",
          "description": "We're a collection of wineries..."
        }
      }
  ],
  "varietalPasses": [
      {
        "passId": "9898-1234",
        "passType": "CHECK_LIST",
        "earned": false,
        "inPlay": false,
        "name": "Rhone Road Trip",
        "description": "Taste a made from each of the 22 Rhone varietals to earn this pass.",
        "imageUrl" : "http://assets.vinpass.com/passes/9898-1234-inplay.jpg",
        "sponsor": {
          "name": "Rhone Wranglers",
          "description": "Rhone wines are made throughout the world..."
        }
      }
  ]
  "brandPasses": [
      {
        "passId": "1234-9884",
        "passType": "PROGRESSIVE",
        "lastActivityDate": "2011-01-05T11:05:14Z",
        "earned": false,
        "inPlay": true,
        "name": "Welcome to Sorella Ridge",
        "description": "Taste your first wine from Sorella Ridge",
        "imageUrl" : "http://assets.vinpass.com/passes/1234-9884-inplay.jpg",
        "sponsor": {
          "name": "Sorella Ridge Winery",
          "description": "A small family run winery located..."
        }
      },
      {
        "passId": "1234-9885",
        "passType": "PROGRESSIVE",
        "earned": false,
        "inPlay": false,
        "name": "Sorella Ridge Explorer",
        "description": "Taste any 5 of our wines to become an Explorer",
        "imageUrl" : "http://assets.vinpass.com/passes/1234-9885-inplay.jpg",
        "sponsor": {
          "name": "Sorella Ridge Winery",
          "description": "A small family run winery located..."
        }
      }
  ]
}

Also see the Main VinPass API page, Activities page, and Scoreboard page.

Comments are closed.