Differences

This shows you the differences between two versions of the page.

--- en:sedamo:api:sedamo_api_status_codes [2022/03/26 15:20] – ↷ Page moved from i:sedamo:api:sedamo_api_status_codes to en:sedamo:api:sedamo_api_status_codes admin
+++ en:sedamo:api:sedamo_api_status_codes [2022/03/26 15:27] (current) – admin
@@ Line 1: / Line 1: @@
+====== sedamo API status codes ======
+The //sedamo// API sends back a status code in the field "''status''", which can contain:
+  * ''status = ok'': No error occurred, the requested data are in the other fields.
+  * ''status = warning'': The request could not be processed as intended. A description is given in the field  "''message''".
+  * ''status = error'': An error occurred, the request could not be processed. The description of the error is in the field  "''message''".
+Examples:
+After [[en:sedamo:api:sedamo_api_method_job_retrieve|requesting an address]]:
+<code JAVA>
+{
+    "status": "error",
+    "message": "no access credit left"
+}
+</code>
+After [[en:sedamo:api:sedamo_api_method_account_balance|checking the current credit]]:
+<code JAVA>
+{
+    "status": "ok",
+    "access_credit": "0",
+    "lastchanged": "1989-11-09 20:20:00"
+}
+</code>
+After [[en:sedamo:api:sedamo_api_method_job_retrieve|requesting the address]] linked to an e-mail address:
+<code JAVA>
+{
+    "status": "warning",
+    "message": "e-mail not registered"
+}
+</code>
+The e-mail address is valid, and the request was well-formed. Yet no data has been entered for the e-mail address requested.
+[[en:sedamo:api:start|Back to sedamo API start page]]

DAIBOLA

Page Tools

Site Tools

User Tools

Differences