Package: pymetrics-soft-skills-sdk
pymetrics-soft-skills-sdkThis is pymetrics's public API. The API can be used to get information on candidates as part of a job application workflow, or for employee career pathing and development.The typical use case for this is to support an externally initiated assessment for a candidate job application.
This is often done "inline" with the candidate's application, or asynchronously after the candidate submits their application.
This data can then be used for career pathing and employee development in subsequent stages.The expected sequence of API calls is:Generate OAuth Tokenwith the OAuth Client ID and Secret you've been providedGet Assessment Configurationsto determine which configured assessment templates are availableCreate Assessment Orderfor a selected Assessment and candidate job applicationGet Assessment Orderto receive the recommendation results and reports, once they are availableThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 2.2.0Package version: 1.0.0Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegenRequirements.Python 2.7 and 3.4+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pip installpipinstallpymetrics_soft_skills_sdkThen import the package:importpymetrics_soft_skills_sdkSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importpymetrics_soft_skills_sdkGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportpymetrics_soft_skills_sdkfrompymetrics_soft_skills_sdk.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=pymetrics_soft_skills_sdk.Configuration(host="http://localhost")# Enter a context with an instance of the API clientwithpymetrics_soft_skills_sdk.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=pymetrics_soft_skills_sdk.DefaultApi(api_client)authorization='authorization_example'# str | Standard Bearer token request, from `Generate OAuth Token`. Formatted `Bearer {token}` (optional)x_api_key='x_api_key_example'# str | Mandatory API Key that pymetrics will provide (optional)order_request=pymetrics_soft_skills_sdk.OrderRequest()# OrderRequest | Candidate, assessment, and job application details (optional)try:# Create Assessment Orderapi_response=api_instance.mercury_create_order_v2(authorization=authorization,x_api_key=x_api_key,order_request=order_request)pprint(api_response)exceptApiExceptionase:print("Exception when calling DefaultApi->mercury_create_order_v2:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionDefaultApimercury_create_order_v2POST/mercury/v2/ordersCreate Assessment OrderDefaultApimercury_get_config_v2GET/mercury/v2/assessmentsGet Assessment ConfigurationsDefaultApimercury_list_orders_v2GET/mercury/v2/ordersList Assessment OrdersDefaultApimercury_o_auth_v2POST/mercury/v2/oauth/tokenGenerate OAuth TokenDefaultApimercury_retrieve_factor_contentGET/mercury/v2/factorContent/{uuid}Get Factor ContentDefaultApimercury_retrieve_order_v2GET/mercury/v2/orders/{uuid}Get Assessment OrderDocumentation For ModelsAssessmentTypeAtsTypeConfigurationErrorResponseListOrdersRequestListOrdersResponseMercuryAssessmentMercuryAssessmentOrderMercuryCandidateMercuryDevelopmentReportContentMercuryFactorContentMercuryModelDirectionMercuryOrderFactorContentMercuryOrderMetadataMercuryReportMercuryResultMercuryRetrieveFactorContentRequestOAuthRequestOAuthResponseOrderCreateResponseOrderRequestPontemOrderStatusesPontemReportTypesAuthorMichelle Tsaimin.tsai@pymetrics.com