Skip to main content

Api unified response state

eviewAbout 2 minevmars

Api unified response state:

status codedescriptionschema
200OKResponseMessageBoolean
400Bad Request
401UnauthorizedResponseMessageTokenState
403ForbiddenResponseMessageObject
404Not FoundResponseMessageObject
406Not AcceptableResponseMessageObject
415Unsupported Media TypeResponseMessageObject
500Internal Server ErrorResponseMessageObject
504Gateway TimeoutResponseMessageObject

Status-200:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult databoolean
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": true,
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-401:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult data,such as:{text=正常, value=normal},{text=已被禁止访问, value=deny},{text=用户未登录, value=expired},{text=用户已在其他地方登录, value=offline},string
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": "",
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-403:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-404:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-406:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-415:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-500:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}

Status-504:

Response Params:

namedescriptiontypeschema
messagemessage contentstring
resultresult dataobject
statusstatus codeinteger(int32)integer(int32)
codebusiness codestring
timestampTimestamp (ms)integer(int64)integer(int64)

Response Example:

{
	"message": "",
	"result": {},
	"status": 0,
	"code": "",
	"timestamp": 0
}