{"swagger":"2.0","info":{"version":"v2","title":"SlideRoom API V2"},"host":"api.slideroom.com","schemes":["https"],"paths":{"/api/v2/applicant/attributes/names":{"get":{"tags":["Applicant"],"summary":"Gets the custom applicant attributes used by the organization.","operationId":"Applicant_GetAttributeNamesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v2/application/{applicationId}/attributes":{"get":{"tags":["Application"],"summary":"Gets the custom attributes for an application.","operationId":"Application_GetAttributesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The ID of the application.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"string"}},"examples":{"application/json":{"name1":"Value1","name2":"Value2"}}}}},"post":{"tags":["Application"],"summary":"Updates the custom attributes for an application. API Import is available in the Advanced Plan.","description":"This method only adds or updates attributes. Null values will be updated as nulls, but not deleted.","operationId":"Application_PostAttributesV2","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The ID of the application.","required":true,"type":"string"},{"name":"data","in":"body","description":"The name/value pairs of the attributes.","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"name1":"Value1","name2":"Value2"}}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}},"delete":{"tags":["Application"],"summary":"Deletes a custom attribute for an application.","operationId":"Application_DeleteAttributesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The ID of the application.","required":true,"type":"string"},{"name":"name","in":"query","description":"The name of the attribute to be deleted.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/api/v2/application/attributes/names":{"get":{"tags":["Application"],"summary":"Gets the custom application attributes used by the organization.","operationId":"Application_GetAttributeNamesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"type":"string"}}}}}},"/api/v2/application/{applicationId}/request-export":{"post":{"tags":["Application"],"summary":"Requests the generation of a single application export file (tabular, pdf, zip).","description":"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.","operationId":"Application_RequestExportByApplicationIdV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"applicationId","in":"path","description":"The id of the application to export","required":true,"type":"string"},{"name":"format","in":"query","required":false,"type":"string","enum":["csv","tsv","txt","tab","xlsx","pdf","zip","json"]},{"name":"roundType","in":"query","required":false,"type":"string","enum":["Assigned","Current","Named","All"]},{"name":"roundName","in":"query","required":false,"type":"string"},{"name":"tab.export","in":"query","required":false,"type":"string"},{"name":"pdf.includeForms","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeReferences","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeMedia","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeApplicantAttachments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeOrganizationAttachments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeRatings","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeFullPageMedia","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeHighlights","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeComments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeCommonApp","in":"query","required":false,"type":"boolean"},{"name":"zip.originalMedia","in":"query","required":false,"type":"boolean"},{"name":"zip.includeForms","in":"query","required":false,"type":"boolean"},{"name":"zip.includeReferences","in":"query","required":false,"type":"boolean"},{"name":"zip.includeMedia","in":"query","required":false,"type":"boolean"},{"name":"zip.includeApplicantAttachments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeOrganizationAttachments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeRatings","in":"query","required":false,"type":"boolean"},{"name":"zip.includeComments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeCommonApp","in":"query","required":false,"type":"boolean"},{"name":"delivery.account","in":"query","required":false,"type":"string"},{"name":"delivery.folder","in":"query","required":false,"type":"string"}],"responses":{"202":{"description":"Accepted","schema":{"$ref":"#/definitions/RequestApplicationExportResultV2"}},"400":{"description":"Bad Request"}}}},"/api/v2/application/request-export":{"post":{"tags":["Application"],"summary":"Requests the generation of application export files (tabular, pdf, zip).","description":"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.\r\nPDF and ZIP exports are available in the Advanced Plan.","operationId":"Application_RequestExportV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","required":false,"type":"string","enum":["csv","tsv","txt","tab","xlsx","pdf","zip","json"]},{"name":"roundType","in":"query","required":false,"type":"string","enum":["Assigned","Current","Named","All"]},{"name":"roundName","in":"query","required":false,"type":"string"},{"name":"tab.export","in":"query","required":false,"type":"string"},{"name":"pdf.includeForms","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeReferences","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeMedia","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeApplicantAttachments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeOrganizationAttachments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeRatings","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeFullPageMedia","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeHighlights","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeComments","in":"query","required":false,"type":"boolean"},{"name":"pdf.includeCommonApp","in":"query","required":false,"type":"boolean"},{"name":"zip.originalMedia","in":"query","required":false,"type":"boolean"},{"name":"zip.includeForms","in":"query","required":false,"type":"boolean"},{"name":"zip.includeReferences","in":"query","required":false,"type":"boolean"},{"name":"zip.includeMedia","in":"query","required":false,"type":"boolean"},{"name":"zip.includeApplicantAttachments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeOrganizationAttachments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeRatings","in":"query","required":false,"type":"boolean"},{"name":"zip.includeComments","in":"query","required":false,"type":"boolean"},{"name":"zip.includeCommonApp","in":"query","required":false,"type":"boolean"},{"name":"delivery.account","in":"query","required":false,"type":"string"},{"name":"delivery.folder","in":"query","required":false,"type":"string"},{"name":"since","in":"query","required":false,"type":"integer","format":"int32"},{"name":"pool","in":"query","required":false,"type":"string","enum":["All","Current","Archived","CommonAppSDS"]},{"name":"status","in":"query","required":false,"type":"string","enum":["All","InProgress","Submitted"]},{"name":"searchName","in":"query","required":false,"type":"string"},{"name":"email","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/RequestApplicationExportResultV2"}}}}},"/api/v2/export/{token}":{"get":{"tags":["Export"],"summary":"Gets the status/result of a requested export.","operationId":"Export_GetV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"token","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ExportResultV2"}}}}},"/api/v2/applicant/attributes":{"get":{"tags":["Applicant"],"summary":"Gets the custom attributes for an applicant.","operationId":"Applicant_GetAttributesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"query","description":"The email address of the applicant.","required":true,"type":"string"},{"name":"pool","in":"query","required":false,"type":"string","enum":["Standard","CommonAppSDS"]},{"name":"commonAppYear","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"string"}},"examples":{"application/json":{"name1":"Value1","name2":"Value2"}}}}},"post":{"tags":["Applicant"],"summary":"Updates the custom attributes for an applicant.","description":"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.","operationId":"Applicant_PostAttributesV2","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"query","description":"The email address of the applicant.","required":true,"type":"string"},{"name":"data","in":"body","description":"The name/value pairs of the attributes.","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"},"example":{"name1":"Value1","name2":"Value2"}}},{"name":"pool","in":"query","required":false,"type":"string","enum":["Standard","CommonAppSDS"]},{"name":"commonAppYear","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}},"delete":{"tags":["Applicant"],"summary":"Deletes a custom attribute for an applicant.","operationId":"Applicant_DeleteAttributesV2","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"query","description":"The email address of the applicant.","required":true,"type":"string"},{"name":"name","in":"query","description":"The name of the attribute to be deleted.","required":true,"type":"string"},{"name":"pool","in":"query","required":false,"type":"string","enum":["Standard","CommonAppSDS"]},{"name":"commonAppYear","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}}},"definitions":{"RequestApplicationExportResultV2":{"type":"object","properties":{"message":{"type":"string"},"submissions":{"format":"int32","type":"integer"},"token":{"format":"int32","type":"integer"}}},"ExportResultV2":{"type":"object","properties":{"status":{"type":"string"},"total_files":{"format":"int32","type":"integer"},"completed_files":{"format":"int32","type":"integer"},"file_urls":{"type":"array","items":{"type":"string"}}}}}}