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.

ParameterDescriptionTypeDefined Value SetValue Req'd
queryTypeMust equal "getVocations".STRING"getVocations"Y

Responses

CodeTypeDescription
200JSONThe requested data.
401JSONOccurs for various unauthorized tasks, such as not providing credentials in your parameters.
500JSONOccurs if an internal server error occurs. Contact altitudesupport@geotab.com if this occurs.

Response Schema

AttributeDescriptionData TypeDefined Value Set
VocationIdUnique identifier for vocation type.STRINGSee Vocation descriptions .
VocationVocation shortname.STRINGSee Vocation descriptions .

Sample parameters


{
"queryType": "getVocations",
}