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": []
  }
}

Result Codes

Code

Description

-1

General Error

1000

User invalid credentials

1100

Missing input parameters

1101

Request rejected - too many requests

Result Descriptions

Code

Return Value

Description

1100

error - missing input parameter

1000

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

Available Error Codes and Descriptions

...

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








1000








User_Invalid_Credentials

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

...

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



-1

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

code:9

...