Skip to content

Latest commit

 

History

History
2218 lines (1638 loc) · 157 KB

StandardizedDataApi.md

File metadata and controls

2218 lines (1638 loc) · 157 KB

inda_hr.StandardizedDataApi

All URIs are relative to https://api.inda.ai

Method HTTP request Description
get_company_size_get GET /hr/v2/data/company/size/ Get Company Size
get_company_type_get GET /hr/v2/data/company/type/ Get Company Type
get_contract_type_get GET /hr/v2/data/contract/type/ Get Contract Type
get_disability_get GET /hr/v2/data/disability/ Get Disability
get_education_title_get GET /hr/v2/data/education/title/ Get Education Title
get_email_label_get GET /hr/v2/data/email/label/ Get Email Label
get_employment_type_get GET /hr/v2/data/employment/type/ Get Employment Type
get_field_of_study_get GET /hr/v2/data/education/field-of-study/ Get Field Of Study
get_gender_get GET /hr/v2/data/gender/ Get Gender
get_industries_get GET /hr/v2/data/industries/ Get Industries
get_job_function_get GET /hr/v2/data/job/function/ Get Job Function
get_jobshift_type_get GET /hr/v2/data/jobshift/type/ Get Jobshift Type
get_license_code_get GET /hr/v2/data/license/type/{license_type}/code/ Get License Code
get_license_type_get GET /hr/v2/data/license/type/ Get License Type
get_link_label_get GET /hr/v2/data/link/label/ Get Link Label
get_marital_status_get GET /hr/v2/data/marital-status/ Get Marital Status
get_name_prefix_get GET /hr/v2/data/name/prefix/ Get Name Prefix
get_name_suffix_get GET /hr/v2/data/name/suffix/ Get Name Suffix
get_patent_status_get GET /hr/v2/data/patent/status/ Get Patent Status
get_phone_label_get GET /hr/v2/data/phone/label/ Get Phone Label
get_protected_group_get GET /hr/v2/data/protected-group/ Get Protected Group
get_remote_working_get GET /hr/v2/data/employment/remote-working/ Get Remote Working
get_salary_frequency_get GET /hr/v2/data/salary/frequency/ Get Salary Frequency
get_salary_type_get GET /hr/v2/data/salary/type/ Get Salary Type
get_seniority_level_get GET /hr/v2/data/seniority/level/ Get Seniority Level

get_company_size_get

GetExtendedStandardDataResponse get_company_size_get()

Get Company Size

Lists company size encodings based on LinkedIn Company Size.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from inda_hr.model.get_extended_standard_data_response import GetExtendedStandardDataResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Company Size
        api_response = api_instance.get_company_size_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_company_size_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetExtendedStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_company_type_get

GetStandardDataResponse get_company_type_get()

Get Company Type

Lists company type encodings based on LinkedIn Company Types. English example values: + SELF_EMPLOYED - Self-employed + PUBLIC_COMPANY - Public company + NON_PROFIT - Nonprofit + PARTNERSHIP - Partnership + GOVERNMENT_AGENCY - Government agency + SELF_OWNED - Sole proprietorship + PRIVATELY_HELD - Privately held

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Company Type
        api_response = api_instance.get_company_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_company_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_contract_type_get

GetStandardDataResponse get_contract_type_get()

Get Contract Type

Lists common contract type encodings. English example values: + CASUAL - Casual + TEMPORARY - Temporary + PERMANENT - Permanent

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Contract Type
        api_response = api_instance.get_contract_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_contract_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_disability_get

GetStandardDataResponse get_disability_get()

Get Disability

Lists disability level encodings. Each level represents a disability severity, as described below: + 1 - 1: Needs another person's assistance with daily life tasks + 5 - 5: No limitations in functioning + 4 - 4: Experiences difficulty in just one function + 2 - 2: Inability to perform one or more sensory or physical functions + 3 - 3: Experiences difficulties in multiple sensory or physical functions

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Disability
        api_response = api_instance.get_disability_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_disability_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_education_title_get

GetStandardDataResponse get_education_title_get()

Get Education Title

Lists common education title encodings based on LinkedIn Degree values. English example values: + 241 - Bachelor of Pharmacy - BPharm + 1018 - Doctor of Pharmacy - PharmD + 900 - Doctor of Philosophy - PhD + 563 - Master of Philosophy - MPhil + 570 - Master of Public Administration - MPA + 588 - Master of Public Health - MPH + 645 - Postgraduate Degree + 116 - Associate of Arts - AA + 104 - Associate of Arts and Sciences - AAS + 112 - Associate of Science - AS + 259 - Bachelor of Applied Science - BASc + 258 - Bachelor of Architecture - BArch + 350 - Bachelor of Arts - BA + 450 - Bachelor of Business Administration - BBA + 215 - Bachelor of Commerce - BCom + 206 - Bachelor of Education - BEd + 269 - Bachelor of Engineering - BE + 223 - Bachelor of Fine Arts - BFA + 232 - Bachelor of Laws - LLB + 1037 - Bachelor of Medicine, Bachelor of Surgery - MBBS + 400 - Bachelor of Science - BS + 250 - Bachelor of Technology - BTech + 513 - Diploma of Education + 916 - Doctor of Arts + 921 - Doctor of Education - EdD + 1100 - Doctor of Law - JD + 1100 - Doctor of Law + 1000 - Doctor of Medicine - MD + 937 - Doctor of Science + 535 - Master of Architecture - MArch + 536 - Master of Arts - MA + 700 - Master of Business Administration - MBA + 594 - Master of Computer Applications - MCA + 548 - Master of Divinity - MDiv + 550 - Master of Education - MEd + 551 - Master of Engineering - MEng + 603 - Master of Fine Arts - MFA + 555 - Master of Laws - LLM + 557 - Master of Library & Information Science - MLIS + 626 - Master of Science - MS + 589 - Master of Social Work - MSW + 584 - Master of Technology - MTech + 701 - Executive MBA + 500 - Master's degree + 5 - Middle School Diploma + 10 - High School Diploma + 10 - GED + 100 - Associate's degree + 200 - Bachelor's degree + 914 - Doctor's Degree + 750 - Engineer's degree + 160 - Higher National Diploma + 800 - Licentiate degree + 150 - Foundation degree

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Education Title
        api_response = api_instance.get_education_title_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_education_title_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_email_label_get

GetStandardDataResponse get_email_label_get()

Get Email Label

Lists common email labels encodings. English example values: + OTHER - Other + BUSINESS - Business + PERSONAL - Personal

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Email Label
        api_response = api_instance.get_email_label_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_email_label_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_employment_type_get

GetExtendedStandardDataResponse get_employment_type_get()

Get Employment Type

Lists common employment type encodings based on LinkedIn Employment Types. English example values: + FULL_TIME - Full-time + PART_TIME - Part-time + CONTRACT - Contract + TEMPORARY - Temporary + VOLUNTEER - Volunteer + INTERNSHIP - Internship + SELF_EMPLOYED - Self-employed + FREELANCE - Freelance + APPRENTICESHIP - Apprenticeship + SEASONAL - Seasonal + OTHER - Other

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from inda_hr.model.get_extended_standard_data_response import GetExtendedStandardDataResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Employment Type
        api_response = api_instance.get_employment_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_employment_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetExtendedStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_field_of_study_get

GetStandardDataResponse get_field_of_study_get()

Get Field Of Study

Lists fields of study encodings based on LinkedIn Fields of Study. English example values: + 100992 - Econometrics and Quantitative Economics + 101471 - Management Sciences and Quantitative Methods + 100982 - Research Methodology and Quantitative Methods + 100417 - Quality Control Technology/Technician + 100404 - Water Quality and Wastewater Treatment Management and Recycling Technology/Technician + 100921 - Psychometrics and Quantitative Psychology + 100415 - Quality Control and Safety Technologies/Technicians + 100861 - Youth Ministry + 101372 - Yoga Teacher Training/Yoga Therapy + 100980 - Youth Services/Administration + 100603 - Children and Youth Library Services + 100912 - Psychology + 101001 - Political Science and Government + 101460 - Human Resources Management/Personnel Administration, General + 100892 - Physics + 100865 - Physical Sciences + 101419 - Project Management + 101295 - Pharmacy + 100838 - Philosophy + 100974 - Public Administration + 100151 - Public Relations/Image Management + 100180 - Computer Programming, Specific Applications + 101117 - Industrial and Product Design + 101136 - Photography + 100926 - Counseling Psychology + 100580 - Legal Assistant/Paralegal + 100924 - Clinical Psychology + 101414 - Non-Profit/Public/Organizational Management + 100178 - Computer Programming + 100201 - Information Technology Project Management + 100900 - Theoretical and Mathematical Physics + 101421 - Organizational Leadership + 101413 - Operations Management and Supervision + 100877 - Organic Chemistry + 100001 - Agriculture, Agriculture Operations, and Related Sciences + 101482 - General Sales, Merchandising and Related Marketing Operations + 100927 - Industrial and Organizational Psychology + 101408 - Business Administration, Management and Operations + 100374 - Operations Research + 101321 - Occupational Therapy/Therapist + 100150 - Organizational Communication, General + 100677 - Marine Biology and Biological Oceanography + 100169 - Graphic and Printing Equipment Operator, General Production + 101462 - Organizational Behavior Studies + 101432 - Business/Office Automation/Technology/Data Entry + 101487 - Specialized Sales, Merchandising and Marketing Operations + 101095 - Aviation/Airway Management and Operations + 101287 - Optometry + 100715 - Military Operational Art and Science/Studies + 100891 - Oceanography, Chemical and Physical + 101409 - Business Administration and Management, General + 101475 - Marketing + 100360 - Mechanical Engineering + 100139 - Communication and Media Studies + 100693 - Mathematics + 101476 - Marketing/Marketing Management, General + 101468 - Management Information Systems, General + 101274 - Medicine + 101406 - Business, Management, Marketing, and Related Support Services + 101438 - Business/Managerial Economics + 100447 - Engineering/Industrial Management + 100142 - Mass Communication/Media Studies + 101150 - Music + 101459 - Human Resources Management and Services + 101427 - Accounting and Business/Management + 100761 - Mathematics and Computer Science + 101443 - Finance and Financial Management Services + 100143 - Journalism + 100939 - Criminal Justice and Corrections + 100144 - Broadcast Journalism + 100119 - Japanese Studies + 100462 - Japanese Language and Literature + 100944 - Criminal Justice/Police Science + 100569 - Canadian Law/Legal Studies/Jurisprudence + 100942 - Criminal Justice/Safety Studies + 100847 - Jewish/Judaic Studies + 101158 - Jazz/Jazz Studies + 100037 - Agricultural Communication/Journalism + 100941 - Criminal Justice/Law Enforcement Administration + 100568 - American/U.S. Law/Legal Studies/Jurisprudence + 100281 - Junior High/Intermediate/Middle School Education and Teaching + 101054 - Watchmaking and Jewelrymaking + 101149 - Metal and Jewelry Arts + 100709 - Army JROTC/ROTC + 100707 - Air Force JROTC/ROTC + 100946 - Juvenile Corrections + 100711 - Navy/Marine Corps JROTC/ROTC + 101407 - Business/Commerce, General + 101444 - Finance, General + 100598 - General Studies + 100607 - Biology, General + 101121 - Graphic Design + 101139 - Art/Art Studies, General + 101140 - Fine/Studio Arts, General + 100885 - Geology/Earth Science, General + 100996 - Geography + 100631 - Microbiology, General + 100583 - English Language and Literature, General + 100239 - Educational Leadership and Administration, General + 100140 - Communication, General + 101115 - Design and Visual Communications, General + 100608 - Biology/Biological Sciences, General + 100176 - Information Technology + 100173 - Computer and Information Sciences and Support Services + 101465 - International Business + 100372 - Industrial Engineering + 100999 - International Relations and Affairs + 101120 - Interior Design + 101466 - International Business/Trade/Commerce + 100196 - Computer/Information Technology Administration and Management + 100122 - Spanish and Iberian Studies + 100177 - Informatics + 100773 - International/Global Studies + 101478 - International Marketing + 100602 - Library and Information Science + 100174 - Computer and Information Sciences, General + 101469 - Information Resources Management + 100189 - Computer Science + 101005 - Sociology + 100597 - Liberal Arts and Sciences/Liberal Studies + 100195 - Computer Systems Networking and Telecommunications + 100979 - Social Work + 100349 - Computer Software Engineering + 101511 - History + 101451 - Hospitality Administration/Management + 101196 - Health/Health Care Administration/Management + 101141 - Art History, Criticism and Conservation + 101453 - Hotel/Motel Administration/Management + 100358 - Environmental/Environmental Health Engineering + 100599 - Humanities/Humanistic Studies + 101307 - Public Health + 100792 - Health and Physical Education/Fitness + 101170 - Health Services/Allied Health/Health Sciences, General + 100243 - Higher Education/Higher Education Administration + 100972 - Human Services, General + 100547 - Human Development and Family Studies, General + 101464 - Human Resources Development + 101171 - Health and Wellness, General + 100938 - Homeland Security, Law Enforcement, Firefighting and Related Protective Services + 101315 - Health Services Administration + 101193 - Dental Hygiene/Hygienist + 100540 - Foods, Nutrition, and Wellness Studies, General + 100586 - Creative Writing + 100198 - System, Networking, and LAN/WAN Management/Manager + 101280 - Clinical/Medical Social Work + 100200 - Web/Multimedia Management and Webmaster + 100585 - Writing, General + 100191 - Web Page, Digital/Multimedia and Information Resources Design + 100133 - Women's Studies + 100889 - Hydrology and Water Resources Science + 100078 - Wildlife, Fish and Wildlands Science and Management + 100642 - Wildlife Biology + 100192 - Data Modeling/Warehousing and Database Administration + 100346 - Water Resources Engineering + 101163 - Woodwind Instruments + 100065 - Water, Wetlands, and Marine Resources Management + 101083 - Welding Technology/Welder + 100074 - Wood Science and Wood Products/Pulp and Paper Technology + 101030 - Plumbing and Related Water Supply Services + 100564 - Law + 100582 - English Language and Literature/Letters + 100593 - English Literature (British and Commonwealth) + 101411 - Logistics, Materials, and Supply Chain Management + 100570 - Banking, Corporate, Finance, and Securities Law + 100455 - Linguistics + 100085 - Landscape Architecture + 100600 - Library Science + 100562 - Legal Studies, General + 101256 - Clinical Laboratory Science/Medical Technology/Technologist + 101461 - Labor and Industrial Relations + 100574 - International Law and Legal Studies + 100589 - Literature + 101176 - Speech-Language Pathology/Pathologist + 100280 - Elementary Education and Teaching + 100854 - Theology/Theological Studies + 100353 - Telecommunications Engineering + 100830 - Theatre/Theater + 100390 - Electrical, Electronic and Communications Engineering Technology/Technician + 101452 - Tourism and Travel Services Management + 101480 - Taxation + 100434 - Computer Technology/Computer Systems Technology + 101323 - Physical Therapy/Therapist + 100224 - Culinary Arts/Chef Training + 100258 - Special Education and Teaching + 100250 - Educational/Instructional Technology + 100282 - Secondary Education and Teaching + 100287 - Early Childhood Education and Teaching + 101380 - Registered Nursing/Registered Nurse + 100688 - Neuroscience + 100777 - Classical, Ancient Mediterranean and Near Eastern Studies and Archaeology + 100363 - Naval Architecture and Marine Engineering + 100771 - Natural Sciences + 100218 - Cosmetology, Barber/Styling, and Nail Instructor + 100364 - Nuclear Engineering + 100197 - Network and System Administration/Administrator + 101000 - National Security Policy Studies + 100772 - Nutrition Sciences + 100572 - Energy, Environment, and Natural Resources Law + 100691 - Neurobiology and Behavior + 100541 - Human Nutrition + 100063 - Natural Resources Management and Policy + 100060 - Natural Resources/Conservation, General + 101384 - Family Practice Nurse/Nursing + 101426 - Accounting and Finance + 101445 - Banking and Financial Support Services + 100116 - French Studies + 100793 - Sport and Fitness Administration/Management + 101119 - Fashion/Apparel Design + 101134 - Film/Cinema/Video Studies + 101446 - Financial Planning and Services + 101489 - Fashion Merchandising + 101135 - Cinematography and Film/Video Production + 100544 - Facilities Planning and Management + 100046 - Food Science + 101447 - International Finance + 100494 - French Language and Literature + 101114 - Design and Applied Arts + 101178 - Dentistry + 101174 - Communication Sciences and Disorders, General + 101125 - Drama and Dramatics/Theatre Arts, General + 100993 - Development Economics and International Development + 101297 - Pharmaceutics and Drug Design + 100182 - Data Processing + 100148 - Digital Communication and Media/Multimedia + 101112 - Dance + 101352 - Dietetics/Dietitian + 100855 - Divinity/Ministry + 100094 - American/United States Studies/Civilization + 100081 - City/Urban, Community and Regional Planning + 101006 - Urban Studies/Affairs + 101512 - American History (United States) + 101002 - American Government and Politics (United States) + 100247 - Urban Education and Leadership + 101240 - Diagnostic Medical Sonography/Sonographer and Ultrasound Technician + 100066 - Land Use Planning and Management/Development + 100862 - Urban Ministry + 100073 - Urban Forestry + 100211 - Make-Up Artist/Specialist + 101198 - Health Unit Coordinator/Ward Clerk + 101076 - Upholstery/Upholsterer + 100475 - Ukrainian Language and Literature + 100490 - Urdu Language and Literature + 100112 - Ural-Altaic and Central Asian Studies + 101199 - Health Unit Manager/Ward Supervisor + 100124 - Ukraine Studies + 100522 - Uralic Languages, Literatures, and Linguistics + 100794 - Kinesiology and Exercise Science + 101156 - Keyboard Instruments + 101470 - Knowledge Management + 100120 - Korean Studies + 100463 - Korean Language and Literature + 100226 - Food Preparation/Professional Cooking/Kitchen Assistant + 100286 - Kindergarten/Preschool Education and Teaching + 101326 - Kinesiotherapy/Kinesiotherapist + 100516 - Khmer/Cambodian Language and Literature + 100951 - Law Enforcement Record-Keeping and Evidence Management + 100812 - Birthing and Parenting Knowledge and Skills + 100811 - Health-Related Knowledge and Skills + 100874 - Chemistry + 100347 - Computer Engineering + 100342 - Civil Engineering + 100340 - Chemical Engineering + 100350 - Electrical, Electronics and Communications Engineering + 100990 - Economics + 100351 - Electrical and Electronics Engineering + 100331 - Engineering + 100333 - Aerospace, Aeronautical and Astronautical Engineering + 100337 - Biomedical/Medical Engineering + 101479 - Real Estate + 101330 - Veterinary Medicine + 100168 - Animation, Interactive Technology, Video Graphics and Special Effects + 101109 - Visual and Performing Arts + 101325 - Vocational Rehabilitation Counseling/Counselor + 101221 - Veterinary/Animal Health Technology/Technician and Veterinary Assistant + 101332 - Veterinary Sciences/Veterinary Clinical Sciences, General + 101157 - Voice and Opera + 100633 - Virology + 100019 - Viticulture and Enology + 100162 - Photographic and Film/Video Technology/Technician and Assistant + 101336 - Veterinary Pathology and Pathobiology + 101133 - Film/Video and Photographic Arts + 100658 - Vision Science/Physiological Optics + 101402 - Practical Nursing, Vocational Nursing and Nursing Assistants + 100194 - Modeling, Virtual Environments and Simulation + 101341 - Veterinary Preventive Medicine, Epidemiology, and Public Health + 101335 - Veterinary Microbiology and Immunobiology + 100611 - Biochemistry + 100674 - Biotechnology + 101437 - Business/Corporate Communications + 100638 - Zoology/Animal Biology + 100613 - Molecular Biology + 101547 - Zoological Medicine Residency Program + 101423 - Accounting + 100080 - Architecture + 100152 - Advertising + 100842 - Religion/Religious Studies + 100141 - Speech Communication and Rhetoric + 101036 - Mechanics and Repairers, General + 100420 - Mechanical Engineering Related Technologies/Technicians + 100097 - Russian, Central European, East European and Eurasian Studies + 100147 - Radio and Television

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Field Of Study
        api_response = api_instance.get_field_of_study_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_field_of_study_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_gender_get

GetStandardDataResponse get_gender_get()

Get Gender

Lists common gender encodings. English example values: + Female - Female: The candidate is a woman. + Male - Male: The candidate is a man. + NotKnown - Unknown: The gender is not provided. + Other - Other: The gender is missing. + NotSpecified - Not Specified: The gender is not specified.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Gender
        api_response = api_instance.get_gender_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_gender_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_industries_get

GetStandardDataResponse get_industries_get()

Get Industries

Lists industry encodings based on LinkedIn Industries.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Industries
        api_response = api_instance.get_industries_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_industries_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_job_function_get

GetStandardDataResponse get_job_function_get()

Get Job Function

Lists job function encodings based on LinkedIn Job Functions. English example values: + acct - Accounting / Auditing + adm - Administrative + advr - Advertising + anls - Analyst + art - Art / Creative + bd - Business Development + cnsl - Consulting + cust - Customer Service + dist - Distribution + dsgn - Design + edu - Education + eng - Engineering + fin - Finance + genb - General Business + hcpr - HealthCare Provider + hr - Human Resources + it - Information Technology + lgl - Legal + mgmt - Management + mnfc - Manufacturing + mrkt - Marketing + othr - Other + pr - Public Relations + prch - Purchasing + prdm - Product Management + prjm - Project Management + prod - Production + qa - QualityAssurance + rsch - Research + sale - Sales + sci - Science + stra - Strategy / Planning + supl - Supply Chain + trng - Training + wrt - Writing / Editing

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Job Function
        api_response = api_instance.get_job_function_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_job_function_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_jobshift_type_get

GetStandardDataResponse get_jobshift_type_get()

Get Jobshift Type

Lists common job shift type encodings. English example values: + DAY_SHIFT - Day Shift + AFTERNOON_SHIFT - Afternoon Shift + NIGHT_SHIFT - Night Shift + FIXED_SHIFT - Fixed Shift + ROTATING_SHIFT - Rotating Shift + SPLIT_SHIFT - Split Shift + ONCALL_SHIFT - On-call Shift + WEEKDAY_SHIFT - Weekday Shift + WEEKEND_SHIFT - Weekend Shift

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>it</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Jobshift Type
        api_response = api_instance.get_jobshift_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_jobshift_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>it</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_license_code_get

GetStandardDataResponse get_license_code_get(license_type)

Get License Code

Given a license_type, this method lists the related level encodings. See Get License Type to retrieve license_type admissible values. English example for driving license type values: + A2 - A2: Motorcycles not exceeding a certain power level. The minimum age for category A2 is 18 years. + C1E - C1E: A combination of vehicles consisting of a tractor vehicle in category B or C1 and a trailer or semi-trailer which are between mass. The minimum age for category C1E is 18 years. + D - D: Motor vehicles designed and constructed for the carriage of more than eight passengers in addition to the driver. Motor vehicles which may be driven with a category D licence may be combined with a trailer having a maximum authorised mass which does not exceed 750 kg. + AM - AM: Mopeds. + A1 - A1: Motorcycles and motor tricycles not exceeding a certain power level. The minimum age for category A1 is 16 years. + B1 - B1: Quadricycles. The minimum age for category B1 is 16 years. + D1 - D1: Motor vehicles or carriage of no more than 16 passengers including the driver and with a maximum length. Motor vehicles in this category may be combined with a trailer not exceeding a maximum authorised mass. The minimum age for categories D1 is 21 years. + B - B: Motor vehicles not exceeding certain authorised mass. The minimum age for category B is 18 years. + C - C: Motor vehicles whose maximum authorised exceed a mass and carriage of no more than eight passengers, including the driver. Motor vehicles in this category may be combined with a trailer not exceeding a maximum authorised mass. The minimum age for category C is 21 years. + DE - DE: Combination of vehicles where the tractor vehicle is in category D and its trailer not exceeds a maximum authorised mass. The minimum age for categories DE is fixed at 24 years. + A - A: Motor tricycles not exceeding a certain power level and a minimum age of 21 years. + BE - BE: A combination of vehicles consisting of a tractor vehicle in category B and a trailer or semi-trailer not exceeding a certain mass. The minimum age for category BE is 18 years. + C1 - C1: Motor vehicles which are between mass. The minimum age for category C1 is 18 years. + CE - CE: A combination of vehicles where the tractor vehicle is category C and its trailer or semi-trailer does not exceed a maximum authorised mass. The minimum age for categories CE is 21 years. + D1E - D1E: A combination of vehicles where the tractor vehicle is category C1 and its trailer does not exceed a maximum authorised mass. The minimum age for categories D1E is fixed at 21 years.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    license_type = "license_type_example" # str | 
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get License Code
        api_response = api_instance.get_license_code_get(license_type)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_license_code_get: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get License Code
        api_response = api_instance.get_license_code_get(license_type, dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_license_code_get: %s\n" % e)

Parameters

Name Type Description Notes
license_type str
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_license_type_get

GetStandardDataResponse get_license_type_get()

Get License Type

Lists common license type encodings. English example values: + DRIVING - Driving license

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get License Type
        api_response = api_instance.get_license_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_license_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_link_label_get

GetStandardDataResponse get_link_label_get()

Get Link Label

Lists common link label encodings. English example values: + TWITTER - Twitter + INSTAGRAM - Instagram + LINKEDIN - LinkedIn + GITHUB - GitHub + YOUTUBE - YouTube + FACEBOOK - Facebook + WIKIPEDIA - Wikipedia + OTHER - Other

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Link Label
        api_response = api_instance.get_link_label_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_link_label_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_marital_status_get

GetStandardDataResponse get_marital_status_get()

Get Marital Status

Lists common marital status encodings. English example values: + MARRIED - Married + WIDOWED - Widowed + SEPARATED - Separated + DIVORCED - Divorced + SINGLE - Single + DOMESTIC_PARTNERSHIP - Domestic partnership

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Marital Status
        api_response = api_instance.get_marital_status_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_marital_status_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_name_prefix_get

GetStandardDataResponse get_name_prefix_get()

Get Name Prefix

Lists common name prefix encodings. English example values: + PROF - Prof. + MR - Mr. + MRS - Mrs. + MX - Mx. + MS - Ms. + LAWYER - Lawyer + MISS - Miss. + DR - Dr. + ENG - Eng.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Name Prefix
        api_response = api_instance.get_name_prefix_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_name_prefix_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_name_suffix_get

GetStandardDataResponse get_name_suffix_get()

Get Name Suffix

Lists common name suffix encodings. English example values: + SR - Sr. + II - II + III - III + JR - Jr.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Name Suffix
        api_response = api_instance.get_name_suffix_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_name_suffix_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_patent_status_get

GetStandardDataResponse get_patent_status_get()

Get Patent Status

Lists common patent status encodings. English example values: + PatentPending - Pending: The patent’s processing is pending. + PatentFiled - Filed: The patent has been filed. + PatentIssued - Issued: The patent has been issued.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Patent Status
        api_response = api_instance.get_patent_status_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_patent_status_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_phone_label_get

GetStandardDataResponse get_phone_label_get()

Get Phone Label

Lists common phone label encodings. English example values: + BUSINESS - Business + PERSONAL - Personal + FAX - Fax + OTHER - Other

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Phone Label
        api_response = api_instance.get_phone_label_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_phone_label_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_protected_group_get

GetStandardDataResponse get_protected_group_get()

Get Protected Group

Lists common protected group encodings. English example values: + ETHNICITY - Ethnicity + NATIONAL_ORIGIN - National Origin + RELIGION - Religion + VETERAN_STATUS - Veteran Status + GENETIC_INFORMATION - Genetic Information + RACE - Race + GENDER - Gender + GENDER_IDENTITY - Gender Identity + PREGNANCY - Pregnancy + AGE - Age + CITIZENSHIP_STATUS - Citizenship Status + MARITAL_STATUS - Marital Status + SEXUAL_ORIENTATION - Sexual Orientation + DISABILITY - Disability + FAMILIAL_STATUS - Familial Status

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Protected Group
        api_response = api_instance.get_protected_group_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_protected_group_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_remote_working_get

GetStandardDataResponse get_remote_working_get()

Get Remote Working

Lists remote working options based on LinkedIn Remote Working. English example values: + ON-SITE - On-site: Employees come to work in-person. + HYBRID - Hybrid: Employees work on-site and off-site. + REMOTE - Remote: Employees work off-site.

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Remote Working
        api_response = api_instance.get_remote_working_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_remote_working_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_salary_frequency_get

GetStandardDataResponse get_salary_frequency_get()

Get Salary Frequency

Lists common salary frequency encodings. English example values: + YEARLY - Yearly + MONTHLY - Monthly + WEEKLY - Weekly + DAILY - Daily + HOURLY - Hourly

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Salary Frequency
        api_response = api_instance.get_salary_frequency_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_salary_frequency_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_salary_type_get

GetStandardDataResponse get_salary_type_get()

Get Salary Type

Lists common salary type encodings. English example values: + NET - Net + GROSS - Gross

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.get_standard_data_response import GetStandardDataResponse
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Salary Type
        api_response = api_instance.get_salary_type_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_salary_type_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_seniority_level_get

GetExtendedStandardDataResponse get_seniority_level_get()

Get Seniority Level

Lists common seniority level encodings. English example values: + 1 - Unpaid + 2 - Training + 4 - Entry-level + 7 - Senior + 8 - Manager + 9 - Director + 11 - Vice President (VP) + 12 - Chief X Officer (CxO) + 13 - Partner + 14 - Owner + 3 - Internship + 5 - Associate + 6 - Mid-Senior level + 10 - Executive + 0 - Not Applicable

Example

  • Bearer Authentication (APIKey):
import time
import inda_hr
from inda_hr.api import standardized_data_api
from inda_hr.model.error_model import ErrorModel
from inda_hr.model.http_validation_error import HTTPValidationError
from inda_hr.model.get_extended_standard_data_response import GetExtendedStandardDataResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.inda.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = inda_hr.Configuration(
    host = "https://api.inda.ai"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: APIKey
configuration = inda_hr.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Enter a context with an instance of the API client
with inda_hr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = standardized_data_api.StandardizedDataApi(api_client)
    dst_lang = "it" # str | The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> (optional) if omitted the server will use the default value of "it"
    codes = [
        None,
    ] # [bool, date, datetime, dict, float, int, list, str, none_type] | If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get Seniority Level
        api_response = api_instance.get_seniority_level_get(dst_lang=dst_lang, codes=codes)
        pprint(api_response)
    except inda_hr.ApiException as e:
        print("Exception when calling StandardizedDataApi->get_seniority_level_get: %s\n" % e)

Parameters

Name Type Description Notes
dst_lang str The language in which the 'Value' is returned. Supported languages: <code style='color: #333333; opacity: 0.9'>it</code>, <code style='color: #333333; opacity: 0.9'>en</code>, <code style='color: #333333; opacity: 0.9'>es</code>, <code style='color: #333333; opacity: 0.9'>pt</code>, <code style='color: #333333; opacity: 0.9'>de</code>, <code style='color: #333333; opacity: 0.9'>fr</code>, <code style='color: #333333; opacity: 0.9'>pl</code> [optional] if omitted the server will use the default value of "it"
codes [[bool, date, datetime, dict, float, int, list, str, none_type]](bool, date, datetime, dict, float, int, list, str, none_type.md) If <code style='color: #333333; opacity: 0.9'>null</code> the API returns all the corresponding <code style='color: #333333; opacity: 0.9'>lang</code> data. [optional]

Return type

GetExtendedStandardDataResponse

Authorization

APIKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful Response -
404 Not Found -
503 Service Unavailable -
422 Validation Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]