Visit BenQ Education website for education solutions
  • Topics

X-Sign OpenAPI

X-sign 2.0 / X-Sign OpenAPI / Documentation

General Status code

2021 / 04 / 24

HTTP Status Code : equals to Result Code
    ex.HTTP Status Code of Result Code 401 is also 401. 
HTTP Status Code 422 will has error message in response body.

{
    "result_code":422,
    "message":{ "Unprocessab leEntity"


    }
}

StatusCode

HttpFoundation

Message

Description

StatusCode

200

HttpFoundation

HTTP_OK

Message

OK

Description

Successful

StatusCode

400
HttpFoundation
HTTP_BAD_REQUEST                               

Message

Bad Request 
Description
Request parameter is missing or invalid

StatusCode

401
HttpFoundation
HTTP_UNAUTHORIZED

Message

Unauthorized
Description
- account ID or password is incorrect 
- Token is invalid
- Client-id or Secret is invalid

StatusCode

403
HttpFoundation
HTTP_FORBIDDEN                           

Message

Forbidden    
Description
- the server understood the request but refuses to authorize it.

StatusCode

404

HttpFoundation

HTTP_NOT_FOUND                                    

Message

Not Found
Description
 resource not found

StatusCode

405
HttpFoundation
HTTP_METHOD_NOT_ALLOWED

Message

Method Not                                Allowed
Description
- Content-Type Error
- Request header field is missing

StatusCode

412
HttpFoundation
HTTP_PRECONDITION_FAILED

Message

Precondition Failed
Description
request tries to modify a resource that is in an unexpected state

StatusCode

422
HttpFoundation
HTTP_UNPROCESSABLE_ENTITY

Message

Unprocessable Entity
Description
- Data not existing in DB

StatusCode

500
HttpFoundation
HTTP_INTERNAL_SERVER_ERROR

Message

Internal Server Error
Description
 

Result Code for X-Sign

Result_code Description
Result_code
--     
Description
--