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

Invalid user credentials

1100

Missing input parameters

1101

Request rejected - too many requests

Result Descriptions

Result Code

Result Name

Result Description

Internal Code

-1General_Error

Code

Return Value

Description







1100

error - missing input parameter

1000

-1

error -

internal user validation

request failed [internal-code:

X]

Available Error Codes and Descriptions

General

1]

error - request failed

[internal-code:

1General_Error

0]

error - request

failed

timeout [internal-code:

0General_Error

2]

error - method is not available

error - invalid events request

timeout

request fields not found [internal-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

1000User_Invalid_Credentials

5]

request failed [internal-code:4]

request fields not found [internal-code:6]

error - internal error [internal-code:8]

error - internal error [internal-code:9]

Code

Return Value






1000

error - internal user validation failed

[internal-code:0]

error - user rejected

[internal-code:X]

error - internal user validation failed

[internal-code:1]

error

- the

user no allowed assets

?

error - user invalid authorization

?

error - user invalid source IP

?

error - internal error

[internal-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_

]

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

Code

Return Value

1100

error - 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

Return Value

1101

error - too many requests