services.submissions.md

services.submissions

This module provides a service to get submissions data from Topcoder via API V5.

• services.submissions
  • static
    • .getService(tokenV3) ⇒ SubmissionsService
  • inner
    • ~SubmissionsService
      • new SubmissionsService(tokenV3)
      • .getSubmissions(filters, params) ⇒ Promise
      • .getSubmissionInformation(submissionId) ⇒ Promise
      • .downloadSubmission(submissionId) ⇒ Promise

services.submissions.getService(tokenV3) ⇒ SubmissionsService

Returns a new or existing submissions service.

Kind: static method of services.submissions Returns: SubmissionsService - Submissions service object

Param	Type	Description
tokenV3	String	Optional. Auth token for Topcoder API v5.

services.submissions~SubmissionsService

Kind: inner class of services.submissions

• ~SubmissionsService
  • new SubmissionsService(tokenV3)
  • .getSubmissions(filters, params) ⇒ Promise
  • .getSubmissionInformation(submissionId) ⇒ Promise
  • .downloadSubmission(submissionId) ⇒ Promise

new SubmissionsService(tokenV3)

Param	Type	Description
tokenV3	String	Optional. Auth token for Topcoder API v5.

submissionsService.getSubmissions(filters, params) ⇒ Promise

Gets submissions.

Kind: instance method of SubmissionsService Returns: Promise - Resolves to the submissions.

Param	Type	Description
filters	Object	Filters
params	Object	Parameters

submissionsService.getSubmissionInformation(submissionId) ⇒ Promise

Gets submission information.

Kind: instance method of SubmissionsService Returns: Promise - Resolves to the submission information.

Param	Type	Description
submissionId	String	The id of submission

submissionsService.downloadSubmission(submissionId) ⇒ Promise

Download submission.

Kind: instance method of SubmissionsService Returns: Promise - Resolves to the submission file.

Param	Type	Description
submissionId	String	The id of submission