@datafire/slideroom

Client library for SlideRoom API V2

Installation and Usage

npm install --save @datafire/slideroom

let slideroom = require('@datafire/slideroom').create();

.then(data => {
  console.log(data);
});

Description

SlideRoom provides a RESTful API for exporting data out of your organization's SlideRoom account.

Actions

Applicant_DeleteAttributesV2

Deletes a custom attribute for an applicant.

slideroom.Applicant_DeleteAttributesV2({
  "email": "",
  "name": ""
}, context)

Input

• input object
  • email required string: The email address of the applicant.
  • name required string: The name of the attribute to be deleted.
  • pool string (values: Standard, CommonAppSDS)
  • commonAppYear integer

Output

• output string

Applicant_GetAttributesV2

Gets the custom attributes for an applicant.

slideroom.Applicant_GetAttributesV2({
  "email": ""
}, context)

Input

• input object
  • email required string: The email address of the applicant.
  • pool string (values: Standard, CommonAppSDS)
  • commonAppYear integer

Output

• output object

Applicant_PostAttributesV2

This method only adds or updates attributes. Null values will be updated as nulls, but not deleted. API Import is available in the Advanced Plan.

slideroom.Applicant_PostAttributesV2({
  "email": "",
  "data": {}
}, context)

Input

• input object
  • email required string: The email address of the applicant.
  • data required object
  • pool string (values: Standard, CommonAppSDS)
  • commonAppYear integer

Output

• output string

Applicant_GetAttributeNamesV2

Gets the custom applicant attributes used by the organization.

slideroom.Applicant_GetAttributeNamesV2(null, context)

Input

This action has no parameters

Output

• output array
  • items string

Application_GetAttributeNamesV2

Gets the custom application attributes used by the organization.

slideroom.Application_GetAttributeNamesV2(null, context)

Input

This action has no parameters

Output

• output array
  • items string

Application_RequestExportV2

Exports are generated asynchronously within SlideRoom. To retrieve the export file generated by this request, use the api/v#/export/{token} endpoint to check the progress/result of the generation process. PDF and ZIP exports are available in the Advanced Plan.

slideroom.Application_RequestExportV2({}, context)

Input

• input object
  • format string (values: csv, tsv, txt, tab, xlsx, pdf, zip, json)
  • roundType string (values: Assigned, Current, Named, All)
  • roundName string
  • tab.export string
  • pdf.includeForms boolean
  • pdf.includeReferences boolean
  • pdf.includeMedia boolean
  • pdf.includeApplicantAttachments boolean
  • pdf.includeOrganizationAttachments boolean
  • pdf.includeRatings boolean
  • pdf.includeFullPageMedia boolean
  • pdf.includeHighlights boolean
  • pdf.includeComments boolean
  • pdf.includeCommonApp boolean
  • zip.originalMedia boolean
  • zip.includeForms boolean
  • zip.includeReferences boolean
  • zip.includeMedia boolean
  • zip.includeApplicantAttachments boolean
  • zip.includeOrganizationAttachments boolean
  • zip.includeRatings boolean
  • zip.includeComments boolean
  • zip.includeCommonApp boolean
  • delivery.account string
  • delivery.folder string
  • since integer
  • pool string (values: All, Current, Archived, CommonAppSDS)
  • status string (values: All, InProgress, Submitted)
  • searchName string
  • email string

Output

• output RequestApplicationExportResultV2

Application_DeleteAttributesV2

Deletes a custom attribute for an application.

slideroom.Application_DeleteAttributesV2({
  "applicationId": "",
  "name": ""
}, context)

Input

• input object
  • applicationId required string: The ID of the application.
  • name required string: The name of the attribute to be deleted.

Output

• output string

Application_GetAttributesV2

Gets the custom attributes for an application.

slideroom.Application_GetAttributesV2({
  "applicationId": ""
}, context)

Input

• input object
  • applicationId required string: The ID of the application.

Output

• output object

Application_PostAttributesV2

This method only adds or updates attributes. Null values will be updated as nulls, but not deleted.

slideroom.Application_PostAttributesV2({
  "applicationId": "",
  "data": {}
}, context)

Input

• input object
  • applicationId required string: The ID of the application.
  • data required object

Output

• output string

Application_RequestExportByApplicationIdV2

Exports are generated asynchronously within SlideRoom. To retrieve the export file generated by this request, use the api/v#/export/{token} endpoint to check the progress/result of the generation process.

slideroom.Application_RequestExportByApplicationIdV2({
  "applicationId": ""
}, context)

Input

• input object
  • applicationId required string: The id of the application to export
  • format string (values: csv, tsv, txt, tab, xlsx, pdf, zip, json)
  • roundType string (values: Assigned, Current, Named, All)
  • roundName string
  • tab.export string
  • pdf.includeForms boolean
  • pdf.includeReferences boolean
  • pdf.includeMedia boolean
  • pdf.includeApplicantAttachments boolean
  • pdf.includeOrganizationAttachments boolean
  • pdf.includeRatings boolean
  • pdf.includeFullPageMedia boolean
  • pdf.includeHighlights boolean
  • pdf.includeComments boolean
  • pdf.includeCommonApp boolean
  • zip.originalMedia boolean
  • zip.includeForms boolean
  • zip.includeReferences boolean
  • zip.includeMedia boolean
  • zip.includeApplicantAttachments boolean
  • zip.includeOrganizationAttachments boolean
  • zip.includeRatings boolean
  • zip.includeComments boolean
  • zip.includeCommonApp boolean
  • delivery.account string
  • delivery.folder string

Output

• output RequestApplicationExportResultV2

Export_GetV2

Gets the status/result of a requested export.

slideroom.Export_GetV2({
  "token": 0
}, context)

Input

• input object
  • token required integer

Output

• output ExportResultV2

Definitions

ExportResultV2

• ExportResultV2 object
  • completed_files integer
  • file_urls array
    • items string
  • status string
  • total_files integer

RequestApplicationExportResultV2

• RequestApplicationExportResultV2 object
  • message string
  • submissions integer
  • token integer