REST API

Server Errors

In case of an error, the server responds with JSON object containing error field (error description in English). Error object also may contain error_id and error_data fields. error_id uniquely identifies the error message and may be used for message translation. error_data contains additional data related to the error (e.g., for invalid input parameters error, it may contain parameter names).

There is a tool extract_errors to extract error identifiers from Erlang server code. It extracts pairs of error_id and error values in TSV (Tab Separated Values) format. E.g., to get error_id identifiers for GDTI and analytics server code:

> ./extract_errors ./gdti_service ./analytic_service
analytic-missing_schema    Current participant has no index schema.
analytic-missing_schema_field    Field missing in participant index schema.
analytic-non_system    Current participant must be system.
analytic-schema_load    Couldn't load participant index schema.
gdti-bad_doc_type    The requested document type isn't valid.
gdti-bad_prefix    Company prefix doesn't match prefixes of participant.
gdti-big_doc_type    Document type is too big for the company prefix.
gdti-global_doc_exists    Document with the GDTI is already exists.
gdti-no_global_doc    Couldn't find the requested global document.
gdti-no_req_widget    Required widget missing in one of the sources.
gdti-not_owner    Participant must be owner of the global document.

DEV Environment

End point Region URL Port
Identity All https://dev.shping.com/identity-service/ 8000
Settings All https://dev.shping.com/settings-service/ 8001
Timeline All https://dev.shping.com/timeline-service/ 8002
Authentication All https://dev.shping.com/authentication-service/ 8003
Notify All https://dev.shping.com/notify-service/ 8004
Upload All https://dev.shping.com/upload-service/ 8007
Supplychain All https://dev.shping.com/supplychain-service/ 8008
Description All https://dev.shping.com/description-service/ 8009
Serialization All https://dev.shping.com/serialization-service/ 8010
Rewards All https://dev.shping.com/rewards-service/ 8011
Buddies All https://dev.shping.com/buddies-service/ 8012
Participant All https://dev.shping.com/participant-service/ 8013
Track&Trace All https://dev.shping.com/track-trace-service/ 8014
Index All https://dev.shping.com/index-service/ 8015
Contributors All https://dev.shping.com/contributors-service/ 8016
Payments All https://dev.shping.com/payments-service/ 8017
Chat All https://dev.shping.com/chat-service/ 8018
Analytic All https://dev.shping.com/analytic-service/ 8019
Reviews All https://dev.shping.com/reviews-service/ 8020
ToDo Cards All https://dev.shping.com/todocards-service/ 8021
GPC All https://dev.shping.com/gpc-service/ 8023
GDTI All https://dev.shping.com/gdti-service/ 8024

results matching ""

    No results matching ""