response codes

Agent Server REST API response codes

200 - Success

Response Sample (JSON)

{
  "code": 200,
  "message": "Success"
}
circle-info

Success

1000 - invalid request data

Response Sample (JSON)

{
  "code": 1000,
  "message": "invalid request data",
  "errors": [
    {
      "msg": "Invalid value",
      "param": "x-agent-api-token",
      "location": "headers"
    }
  ]
}
circle-info

In case when the required input parameter is omitted or parameter type does not match

1001 - not found data. check parameters

Response Sample (JSON)

circle-info

Data not found

1002 - agent api access token validate failed

Response Sample (JSON)

circle-info

Agent api access token error

1003 - agent service error

Response Sample (JSON)

circle-info

Agent service exception error

1100 - internal service error

Response Sample (JSON)

circle-info

External interface processing error

1201 - exist session id

Response Sample (JSON)

circle-info

Duplication error addsymmetrickey session id

1202 - not enough budget

Response Sample (JSON)

circle-info

Insufficient sp budge error

1203 - invalid auth token

Response Sample (JSON)

circle-info

sp auth token error

1300 - failed to verify

Response Sample (JSON)

circle-info

auth verification failed

Last updated

Was this helpful?