Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error message to figure out what has gone wrong and do some debugging.

Status codes

Here is a list of the different categories of status codes returned by the Open Scripture API. Use these to understand if a request was successful.

  • Name
    2xx
    Type
    Description
    A 2xx status code indicates a successful response.
  • Name
    4xx
    Type
    Description
    A 4xx status code indicates a client error — this means there's something wrong with how your request was formatted
  • Name
    5xx
    Type
    Description
    A 5xx status code indicates a server error — you generally won't see this type of error
Note: the Open Scripture API is still in beta, and these resources/endpoints can change at any time