Error handling

Passport APIs will use standard HTTP status codes to reflect the appropriate result of the request. The set of codes we leverage are outlined below. In addition to setting the appropriate HTTP status code, when a problem occurs the API may respond with additional detail in the response body. The format of this detail will follow the standard defined by RFC 7807 which outlines a standard model for describing “Problem Details for HTTP APIs.” Passport defines it’s use of RFC 7807 with the following specifics:

• Problem detail “Types” are a URN that provide a descriptive, human readable error code that is prefixed with the namespace: “io.passportlabs:error:”
• Problem types that are specific to each API will be documented as part of that API
• If additional detail is included as part of the problem detail, those custom fields will be wrapped in an element that is titled “additional_details”

An example is provided below:

{
    "type": “io.passportlabs:error:zone_not_found",
    "title": "Zone not found ",
    "detail": "The zone named 501 was not found",
    “additional_details”: {
   	 "zone_id": 501
    }  
}

HTTP Status Codes

The following HTTP status codes may be leveraged by Passport APIs to convey the appropriate result of a request. Not all APIs will support all of the codes listed below. What codes may occur will be included in the documentation for each API.

Success Responses (2xx)

Client Errors (4xx)

Server Errors (5xx)