codes.md

Server Error Codes

GET /server/codes.{format}

Description

This method returns a list of all possible API error codes

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	No
Method ID	1091	Enabled	Yes
Service Name	server	Service ID	227
Information Steward	UW OpenData	Data Type	API computed
Update Frequency	Every request	Cache Time	0 seconds

Notes

• Calling this method does not affect usage
• Any value can be null

Sources

• https://api.uwaterloo.ca

Parameters

GET /server/codes.{format}

Parameter	Type	Required	Description
format	input	yes	The format of the output
callback	filter	no	JSONP callback format

Output Formats

• json
• xml

Examples

GET /server/codes.{format}

• https://api.uwaterloo.ca/v2/server/codes.json
• https://api.uwaterloo.ca/v2/server/codes.xml
• https://api.uwaterloo.ca/v2/server/codes.json?callback=myResponse

Response

Field Name	Type	Value Description
code	integer	Numerical value of the Error code
message	string	Accompanying error message

Any value can be null

Output

JSON

{
  "meta":{
    "requests":86,
    "timestamp":1381936008,
    "status":200,
    "message":"Request successful",
    "method_id":1091,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "code":200,
      "message":"Request successful"
    },
    {
      "code":204,
      "message":"No data returned"
    },
    {
      "code":401,
      "message":"Invalid API key"
    },
    {
      "code":403,
      "message":"The provided API key has been banned"
    },
    {
      "code":429,
      "message":"API request limit reached"
    },
    {
      "code":501,
      "message":"Invalid method"
    },
    {
      "code":511,
      "message":"API key is required (?key=)"
    }
  ]
}