queryType: getVocations
The getVocations queryType is passed to the API to get a list of vocation information.
Parameters
These parameters should be passed to the functionParameters object regardless of which method you choose from here.
| Parameter | Description | Type | Defined Value Set | Value Required |
|---|---|---|---|---|
| queryType | Must equal "getVocations". | STRING | "getVocations" | Y |
Responses
| Code | Type | Description |
|---|---|---|
| 200 | JSON | The requested data. |
| 401 | JSON | Occurs for various unauthorized tasks, such as not providing credentials in your parameters. |
| 500 | JSON | Occurs if an internal server error occurs. Contact Altitude Support if this occurs. |
Response Schema
| Attribute | Description | Data Type | Defined Value Set |
|---|---|---|---|
| VocationId | Unique identifier for vocation type. | INTEGER | See Vocation descriptions . |
| Vocation | Vocation shortname. | STRING | See Vocation descriptions . |
Sample parameters
{
"queryType": "getVocations"
}
POI Location Specific Insights usage
Use getVocations to retrieve vocation IDs for filtering POI Location Specific Insights results. The vocation IDs returned here are the same values accepted by the vocations parameter in getPOIAnalytics.
The REST proxy also exposes vocations at GET /api/v2/filters/vocations, which returns the same vocation list in the new REST response format.
