diff --git a/README.md b/README.md index b5fca82..8d42e38 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ When setting up a JSON API, you'll have all kinds of different types of calls an
Type | Description | Required Keys | Optional Keys |
---|---|---|---|
success | All went well, and (usually) some data was returned. | status, data | |
fail | There was a problem with the data submitted, or some pre-condition of the API call wasn't satisfied | status, data | |
fail | There was a problem with the data submitted, or some pre-condition of the API call wasn't satisfied | status, data | message |
error | An error occurred in processing the request, i.e. an exception was thrown | status, message | code, data |