geocaching-api v2.1.1

api_v1_0

ApiV10 - JavaScript client for api_v1_0 API version 1.0. This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: v1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit http://www.geocaching.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install api_v1_0 --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your api_v1_0 from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ApiV10 = require('api_v1_0');


var api = new ApiV10.FriendsApi()
var requestId = 56; // {Number} friend request identifier
var apiVersion = "'1.0'"; // {String} The requested API version
api.friendsAcceptFriendRequest(requestId, apiVersion).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://api.groundspeak.com

Documentation for Models

• ApiV10.AdditionalWaypoint
• ApiV10.Attribute
• ApiV10.AttributeType
• ApiV10.BulkFailure
• ApiV10.BulkResponse
• ApiV10.Coordinates
• ApiV10.Country
• ApiV10.FriendRequest
• ApiV10.GeoTour
• ApiV10.Geocache
• ApiV10.GeocacheCount
• ApiV10.GeocacheLimit
• ApiV10.GeocacheList
• ApiV10.GeocacheLog
• ApiV10.GeocacheLogType
• ApiV10.GeocacheNote
• ApiV10.GeocacheSize
• ApiV10.GeocacheType
• ApiV10.HQPromotionMetadata
• ApiV10.Image
• ApiV10.ListGeocache
• ApiV10.Location
• ApiV10.LogDraft
• ApiV10.MembershipLevel
• ApiV10.PostGeocacheList
• ApiV10.PostGeocacheLog
• ApiV10.PostImage
• ApiV10.PostListGeocache
• ApiV10.PostLogDraft
• ApiV10.PostTrackableLog
• ApiV10.PostUserWaypoint
• ApiV10.PromotedDraft
• ApiV10.Souvenir
• ApiV10.Sponsor
• ApiV10.State
• ApiV10.Trackable
• ApiV10.TrackableCount
• ApiV10.TrackableLog
• ApiV10.TrackableLogType
• ApiV10.TrackableType
• ApiV10.User
• ApiV10.UserData
• ApiV10.UserReference
• ApiV10.UserWaypoint

Documentation for Authorization

AccessToken

• Type: API key
• API key parameter name: AccessToken
• Location: HTTP header