Commits

Greg Salt  committed 6c80c05

Work on response codes

  • Participants
  • Parent commits 429c0fd

Comments (0)

Files changed (2)

File docs/index.rst

    registration.rst
    updater.rst
    developers.rst
+   updater/api.rst
+   updater/response-codes.rst
 
 
-

File docs/updater/response-codes.rst

+.. highlight:: json
+
 Response Codes
 ==============
 
 
 .. code-block:: json
 
-   402 Resource exists
+   {"code": 402, "message": "Resource exists"}
 
 Each host is only allowed to update a set of member data once.
 
+403 Not allowed
+---------------
+
 .. code-block:: json
 
-   403 Not allowed
+   {"code": 403, "message": "Not allowed"}
 
 You may get this response if your account has not been activated yet.
 
+404 Resource does not exist
+---------------------------
+
 .. code-block:: json
 
    404 Resource does not exist
 
 If you've modified the library then make sure that the API endpoints are correct.
 
-405 Guardian limit reached
+501 Incorrect user agent
+------------------------
 
-501 Incorrect user agent
+    {"code": 501, "message": "Incorrect user agent"}
+
+You must use ``Cerberus Updater 1.0`` as the user agent. The library does set this automatically but if you use your own cURL method then you should set this appropriately.
 
 502 Invalid remote host
+-----------------------
+
+    {"code": 502, "message": "Invalid remote host"}
+
+Make sure that your hostname matches the one you registered. Subdomains are counted are separate hosts. For example, ``www.domain.com`` requires a different access key from ``domain.com``.
+
 503 Unable to find access key
 504 Data too long
 505 Unable to decrypt