Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Common Error response has the following format & parameters:

Code Block
{
  "MaxGmtUpdateTime": null,
  "CommonResult": {
    "ResultDescription": "invalid user credentials",
    "ResultCode": 1000,
    "DataSet": []
  }
}

Available Error Codes and Descriptions

General

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

General_Error

...

error - request failed

...

code:1

...

General_Error

...

error - request failed

...

code:0

...

General_Error

...

error - request timeout

...

code:2

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

1100

...

Missing_input_parameter 

...

error - missing input parameter

...

?

User

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

error - internal user validation failed

...

code:0

...

error - user rejected

...

code:X

...

error - internal user validation failed

...

code:1

...

error - the user no allowed assets

...

?

...

error - user invalid authorization

...

?

...

error - user invalid source IP

...

?

...

error - internal error

...

code:3

Interval

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

1101

...

Request_rejected_too_many_requests 

...

error - too many requests

...

?

Time Required Reports

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

1100

...

Missing_input_parameter

...

error - missing time parameter

...

?

Detailed Report Request for an Un-authorized Organization

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

-1

...

General_Error

...

error - method is not available

...

?

Event Request Error

...

Result Code

...

Result Name

...

Result Description

...

Internal Code

...

General_Error

...

error - invalid events request

...

?

...

General_Error

...

error - request fields not found

...

code:5

...

General_Error

...

error - request failed

...

code:4

...

General_Error

...

error - request fields not found

...

code:6

...

1000

...

User_Invalid_Credentials

...

error - internal user validation failed

...

code:7

...

-1

...

General_Error

...

error - internal error

...

code:8

...

-1

...

General_Error

...

error - internal error

...

Result Codes

Code

Description


1

It appears that the organization license type is insufficient, which means that it needs to be upgraded to Gold or Platinum license.
License Plan Type Policy

-1

General Error

1000

Invalid user credentials

1100

Missing input parameters

1101

Request rejected - too many requests

Result Descriptions

Code

Return Value

1

error - org license type is insufficient

Code

Return Value






-1

error - request failed [internal-code:X]

error - request failed [internal-code:5]

error - request timeout [internal-code:X]

error - request fields not found [internal-code:X]

error - internal error [internal-code:X]

error - method is not available

error - invalid events request

error - calculated fields are not supported at the SDK service

Code

Return Value




1000

error - internal user validation failed[internal-code:X]

error - user rejected [internal-code:X]

error - internal error [internal-code:X]

error – user no allowed assets

error - user invalid authorization

error - user invalid source IP
(The IP address will be displayed in the error message)

Code

Return Value


1100

error - missing input parameter

error - missing time parameter

Code

Return Value

1101

error - too many requests