Lookup Professions🔗︎

HTTP Verb	Path
POST	/v10/professions/lookup

Get details for the given professions in the taxonomy.

Info

This is an add-on feature. Reach out to sales@textkernel.com for more information.

Scope of use🔗︎

The purpose of this endpoint is to look up information in our Taxonomy. You must cache or store the response to limit the number of requests. When discontinuing use of our Services, you are required to delete all copies of the Taxonomy.

Request Body🔗︎

CodeIDs 🔗︎ int[] required

CodeIDs🔗︎

The profession code IDs to get details about from the Professions Taxonomy.

OutputLanguage 🔗︎ string

OutputLanguage🔗︎

The language to use for professions descriptions (default is en). Must be an allowed ISO code.

Sample JSON

{
  "CodeIDs": [
    0
  ],
  "OutputLanguage": ""
}

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

TransactionId 🔗︎ string

TransactionId🔗︎

The (GUID) id for a specific API transaction. Use this when contacting support@textkernel.com about issues.

EngineVersion 🔗︎ string

EngineVersion🔗︎

The version of the parsing/matching engine running under-the-hood.

ApiVersion 🔗︎ string

ApiVersion🔗︎

The version of the API.

TotalElapsedMilliseconds 🔗︎ integer

TotalElapsedMilliseconds🔗︎

How long the transaction took on Textkernel's server, in milliseconds. If the transaction takes longer to complete on the client side, that extra duration is solely network latency.

TransactionCost 🔗︎ decimal

TransactionCost🔗︎

How many credits the transaction costs.How many credits the transaction costs.

CustomerDetails 🔗︎ object

CustomerDetails🔗︎

Information about the customer who made the API call.

CustomerDetails properties

AccountId 🔗︎ string

AccountId🔗︎

The AccountId for the account.

Name 🔗︎ string

Name🔗︎

The customer name on the account.

IPAddress 🔗︎ string

IPAddress🔗︎

The client IP Address where the API call originated.

Region 🔗︎ string

Region🔗︎

The region for the account, also known as the 'Data Center'.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of credits remaining to be used by the account.

CreditsUsed 🔗︎ decimal

CreditsUsed🔗︎

The number of credits used by the account.

MaximumConcurrentRequests 🔗︎ integer

MaximumConcurrentRequests🔗︎

The number of requests that can be made at one time. If using sub-accounts, this is the maximum number of concurent requests across all accounts, not just this single sub-account.

ExpirationDate 🔗︎ date

ExpirationDate🔗︎

The date that the current credits expire.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

Professions 🔗︎ object[]

Professions🔗︎

A list of returned professions.

Professions properties

CodeId 🔗︎ int

CodeId🔗︎

The unique code ID of the profession in the Professions Taxonomy.

Description 🔗︎ string

Description🔗︎

The description of the profession in the desired language.

Class 🔗︎ object

Class🔗︎

The class which this profession belongs to.

Class properties

CodeId 🔗︎ int

CodeId🔗︎

The code ID of the parent class in the Professions Taxonomy.

Description 🔗︎ string

Description🔗︎

The description of the class in the desired language.

Group 🔗︎ object

Group🔗︎

The group which this profession belongs to.

Group properties

CodeId 🔗︎ int

CodeId🔗︎

The code ID of the parent group in the Professions Taxonomy.

Description 🔗︎ string

Description🔗︎

The description of the group in the desired language.

Isco 🔗︎ object

Isco🔗︎

The ISCO-2008 details of this profession.

Isco properties

CodeId 🔗︎ string

CodeId🔗︎

The ISCO code/ID.

Description 🔗︎ string

Description🔗︎

The ISCO description.

Onet2019 🔗︎ object

Onet2019🔗︎

The O*NET 2019 details of this profession.

Onet2019 properties

CodeId 🔗︎ string

CodeId🔗︎

The O*NET code/ID.

Description 🔗︎ string

Description🔗︎

The O*NET description.

Onet 🔗︎ object

Onet🔗︎

The O*NET 2010 (deprecated) details of this profession.

Onet properties

CodeId 🔗︎ string

CodeId🔗︎

The O*NET code/ID.

Description 🔗︎ string

Description🔗︎

The O*NET description.

Kldb2020 🔗︎ object

Kldb2020🔗︎

The KLDB-2020 details of this profession.

Kldb2020 properties

CodeId 🔗︎ string

CodeId🔗︎

The KLDB code/ID.

Description 🔗︎ string

Description🔗︎

The KLDB description.

UkSoc2010 🔗︎ object

UkSoc2010🔗︎

The UK-SOC-2010 details of this profession.

UkSoc2010 properties

CodeId 🔗︎ string

CodeId🔗︎

The UK-SOC-2010 code/ID.

Description 🔗︎ string

Description🔗︎

The UK-SOC-2010 description.

UwvBoc 🔗︎ object

UwvBoc🔗︎

The UWV-BOC details of this profession.

UwvBoc properties

CodeId 🔗︎ string

CodeId🔗︎

The UWV-BOC code/ID.

Description 🔗︎ string

Description🔗︎

The UWV-BOC description (Dutch only).

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string",
    "TransactionId": "string",
    "EngineVersion": "string",
    "ApiVersion": "string",
    "TotalElapsedMilliseconds": 0,
    "TransactionCost": 0,
    "CustomerDetails": {
      "AccountId": "string",
      "Name": "string",
      "IPAddress": "string",
      "Region": "string",
      "CreditsRemaining": 0,
      "CreditsUsed": 0,
      "ExpirationDate": "2021-12-31",
      "MaximumConcurrentRequests": 0
    }
  },
  "Value": {
    "Professions": [
      {
        "CodeId": 0,
        "Description": "string",
        "Group": {
          "CodeId": 0,
          "Description": "string"
        },
        "Class": {
          "CodeId": 0,
          "Description": "string"
        },
        "Isco": {
          "CodeId": "string",
          "Description": "string"
        },
        "Onet2019": {
          "CodeId": "string",
          "Description": "string"
        },
        "Onet": {
          "CodeId": "string",
          "Description": "string"
        },
        "Kldb2020": {
          "CodeId": "string",
          "Description": "string"
        },
        "UkSoc2010": {
          "CodeId": "string",
          "Description": "string"
        },
        "UwvBoc": {
          "CodeId": "string",
          "Description": "string"
        }
      }
    ]
  }
}