response codes

Agent Server REST API response codes

200 - Success

Response Sample (JSON)

{
  "code": 200,
  "message": "Success"
}

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

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

1001 - not found data. check parameters

Response Sample (JSON)

{
  "code": 1001,
  "message": "not found data. check parameters"
}

Data not found

1002 - agent api access token validate failed

Response Sample (JSON)

{
  "code": 1002,
  "message": "agent api access token validate failed"
}

Agent api access token error

1003 - agent service error

Response Sample (JSON)

{
  "code": 1003,
  "message": "agent Service Error",
  "errors": {
  }
}

Agent service exception error

1100 - internal service error

Response Sample (JSON)

{
  "code": 1100,
  "message": "Internal Service Error",
  "errors": {
    "code": 3050001,
    "what": "Account name already exists"
  }
}

External interface processing error

1201 - exist session id

Response Sample (JSON)

{
  "code": 1201,
  "message": "exist session id"
}

Duplication error addsymmetrickey session id

1202 - not enough budget

Response Sample (JSON)

{
  "code": 1202,
  "message": "not enough budget"
}

Insufficient sp budge error

1203 - invalid auth token

Response Sample (JSON)

{
  "code": 1203,
  "message": "invalid auth token"
}

sp auth token error

1300 - failed to verify

Response Sample (JSON)

{
  "code": 1300,
  "message": "failed to verify"
}

auth verification failed

Last updated