Skip to content

topcoder-platform/topcoder-api-challenges

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ap_challenge_microservice

ApChallengeMicroservice - JavaScript client for ap_challenge_microservice Services that provide access and interaction with all sorts of challenges, including design, dev, single round matches, and marathon matches. This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.5
  • Package version: 1.0.5
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 ap_challenge_microservice --save
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

Finally, switch to the directory you want to use your ap_challenge_microservice from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('ap_challenge_microservice') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

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 ApChallengeMicroservice = require('ap_challenge_microservice');

var defaultClient = ApChallengeMicroservice.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new ApChallengeMicroservice.DefaultApi()

var id = "id_example"; // {String} the id of the draft challenge


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.activateChallenge(id, callback);

Documentation for API Endpoints

All URIs are relative to http://api.topcoder.com/v4

Class Method HTTP request Description
ApChallengeMicroservice.DefaultApi activateChallenge POST /challenges/{id}/activate
ApChallengeMicroservice.DefaultApi cancelPrivateContest POST /challenges/{id}/cancel
ApChallengeMicroservice.DefaultApi challengeResultsGet GET /challengeResults
ApChallengeMicroservice.DefaultApi challengesGet GET /challenges
ApChallengeMicroservice.DefaultApi challengesIdGet GET /challenges/{id}
ApChallengeMicroservice.DefaultApi challengesIdPut PUT /challenges/{id}
ApChallengeMicroservice.DefaultApi challengesIdResourcesDelete DELETE /challenges/{id}/resources
ApChallengeMicroservice.DefaultApi challengesIdResourcesGet GET /challenges/{id}/resources
ApChallengeMicroservice.DefaultApi challengesIdResourcesPost POST /challenges/{id}/resources
ApChallengeMicroservice.DefaultApi challengesIdResultsGet GET /challenges/{id}/results
ApChallengeMicroservice.DefaultApi challengesMemberGet GET /challenges/member
ApChallengeMicroservice.DefaultApi closePrivateContest POST /challenges/{id}/close
ApChallengeMicroservice.DefaultApi directChallengesGet GET /direct/challenges
ApChallengeMicroservice.DefaultApi getChallengeLegacyInfo GET /challenges/legacyinfo/{challengeId}
ApChallengeMicroservice.DefaultApi getChallengeMetadata GET /challenges/metadata
ApChallengeMicroservice.DefaultApi getChallengeTypes GET /challenge-types
ApChallengeMicroservice.DefaultApi marathonMatcheResultsGet GET /marathonMatcheResults
ApChallengeMicroservice.DefaultApi marathonMatchesGet GET /marathonMatches
ApChallengeMicroservice.DefaultApi membersHandleChallengesGet GET /members/{handle}/challenges
ApChallengeMicroservice.DefaultApi membersHandleMmsGet GET /members/{handle}/mms
ApChallengeMicroservice.DefaultApi membersHandleSrmsGet GET /members/{handle}/srms
ApChallengeMicroservice.DefaultApi phasesGet GET /phases
ApChallengeMicroservice.DefaultApi platformsGet GET /platforms
ApChallengeMicroservice.DefaultApi platformsIdDelete DELETE /platforms/{id}
ApChallengeMicroservice.DefaultApi platformsIdPatch PATCH /platforms/{id}
ApChallengeMicroservice.DefaultApi platformsPost POST /platforms
ApChallengeMicroservice.DefaultApi registerChallenge POST /challenges/{id}/register
ApChallengeMicroservice.DefaultApi saveDraftContest POST /challenges
ApChallengeMicroservice.DefaultApi srmResultsGet GET /srmResults
ApChallengeMicroservice.DefaultApi srmsGet GET /srms
ApChallengeMicroservice.DefaultApi technologiesGet GET /technologies
ApChallengeMicroservice.DefaultApi technologiesIdDelete DELETE /technologies/{id}
ApChallengeMicroservice.DefaultApi technologiesIdPatch PATCH /technologies/{id}
ApChallengeMicroservice.DefaultApi technologiesPost POST /technologies
ApChallengeMicroservice.DefaultApi unregisterChallenge POST /challenges/{id}/unregister

Documentation for Models

Documentation for Authorization

bearer

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