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.
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.
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
CreditsRemaining 🔗︎ decimal
CreditsRemaining🔗︎
The number of credits remaining to be used by the account.
Value 🔗︎ object
Value🔗︎
Contains response data for the transaction.
Value properties
Professions 🔗︎ object[]
Professions🔗︎
A list of returned professions.
Professions properties
Description 🔗︎ string
Description🔗︎
The description of the profession in the desired language.
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"
}
}
]
}
}