}}
    Show / Hide Table of Contents

    Request Handshake

    ID Label Description
    0 HSHK_OK Request is validated and accepted for processing
    1101 HSHK_ERR_RH_HTTP_ACCEPT Missing Accept header in request
    1102 HSHK_ERR_RH_CONTENT_TYPE Missing Content-Type in request header
    1201 HSHK_ERR_UA_MODEL Missing or invalid authentication model specifier
    1203 HSHK_ERR_UA_AUTH Authentication failed
    1204 HSHK_ERR_UA_API_NO_ACCESS API access is not permitted
    1205 HSHK_ERR_UA_API_NO_PPASS Account username and password not permitted for API authentication
    1401 HSHK_ERR_DATA Missing or invalid request data
    1402 HSHK_ERR_BAD_REQUEST Invalid request. Usually when the request is not understood
    1403 HSHK_ERR_INTERNAL Internal application error occured
    1404 HSHK_ERR_UNKNOWN Unknown application error occured
    1405 HSHK_ERR_ACCESS_DENIED Access to requested resource is denied
    1406 HSHK_ERR_API_RETIRED API version being accessed has been retired and therefore cannot be used to make the request
    1407 HSHK_ERR_SERVICE Service for which request is made is not permitted, eg. Voice
    1408 HSHK_ERR_ACCT_INACTIVE Account used in making the request is not active
    1409 HSHK_ERR_ACCT_SUSPENDED Account used in making the request has been suspended
    Back to top