/taxonomies
GET /{taxonomyDimension}
GET /{taxonomyDimension}Get taxonomy dimension concepts.
URL Parameters
| Name | Type | Description |
|---|---|---|
datasetId | string | Dataset ID. Example: local-test-data |
taxonomyDimension | string | Dimension to filter on. Example: company |
Query Parameters
| Name | Type | Description |
|---|---|---|
term | string | Specify a search term to filter on. This parameter is optional. Example: 39742874 |
limit | integer | Specify the concept limit. This parameter is optional. Example: 10 |
boolean | boolean | Autocomplete search terms. Only used in combination with q.
This parameter is optional. Default: true |
Code Examples
curl --request GET \
--url https://api.lightcast.io/alumni-pathways/taxonomies \
--header 'accept: application/json' \
--header 'authorization: Bearer <ACCESS_TOKEN>'Response Examples
{
"data": [
{
"id": "11",
"name": "Engineering"
}
]
}{
"errors": [
{
"status": 404,
"title": "Not found",
"detail": "Invalid request path (dimension: foo): value is not a valid enumeration member; permitted: 'lotocc', 'lotspecocc'"
}
]
}GET/taxonomies/{taxonomyDimension}
GET/taxonomies/{taxonomyDimension}Get taxonomy dimension concepts.
URL Parameters
| Name | Type | Description |
|---|---|---|
taxonomyDimension | string | Dimension to filter on. Example: title |
Query Parameters
| Name | Type | Description |
|---|---|---|
accountId | string | Optional account id. If omitted, defaults to the active account when one exists; otherwise the first linked account. Use this when the client has more than one account. |
term | string | Specify search term to filter on. |
autocomplete | boolean | Autocomplete search terms. (Defaults to true) |
limit | integer | How many search results to return. |
Code Examples
curl --request GET \
--url https://api.lightcast.io/alumni-pathways/taxonomies/taxonomyDimension \
--header 'accept: application/json' \
--header 'authorization: Bearer <ACCESS_TOKEN>'
--header 'content-type: application/json' \Response Examples
{
"data": [
{
"id": "11",
"name": "Engineering"
}
]
}{
"errors": [
{
"status": 400,
"title": "Bad request",
"detail": "Unknown occupation 1234 for dimension lotocc"
}
]
}{
"errors": [
{
"status": 404,
"title": "Not found",
"detail": "Invalid request path (dimension: foo): value is not a valid enumeration member; permitted: 'lotocc', 'lotspecocc'"
}
]
}POST taxonomies/{taxonomyDimension}
POST taxonomies/{taxonomyDimension}Lookup a taxonomy dimension value by ID.
URL Parameters
| Name | Type | Description |
|---|---|---|
datasetId | string | Dataset ID. Example: local-test-data |
taxonomyDimension | string | Dimension to filter on. Example: company |
Request Body
{
"ids": [
"11"
]
}Code Examples
curl --request POST \
--url https://api.lightcast.io/alumni-pathways/taxonomies/taxonomyDimension \
--header 'accept: application/json' \
--header 'authorization: Bearer <ACCESS_TOKEN>'
--header 'content-type: application/json' \
--data '{"ids":[]}'Response Examples
{
"data": [
{
"id": "11",
"name": "Engineering"
}
]
}{
"errors": [
{
"status": 400,
"title": "Bad request",
"detail": "Unknown occupation 1234 for dimension lotocc"
}
]
}{
"errors": [
{
"status": 404,
"title": "Not found",
"detail": "Invalid request path (dimension: foo): value is not a valid enumeration member; permitted: 'lotocc', 'lotspecocc'"
}
]
}