HHS (US Department of Health and Human Services) · Schema

ErrorResponseSchema

HealthPublic HealthGrantsInteroperabilityFHIRGovernmentOpen DataFDAHRSAONC

Properties

Name Type Description
data object Additional data that might be useful in resolving an error (see specific endpoints for details, this is used infrequently)
message string General description of the error
status_code integer The HTTP status code of the error
errors array
internal_request_id string An internal tracking ID
View JSON Schema on GitHub

JSON Schema

errorresponse.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.simpler.grants.gov/schemas/ErrorResponseSchema",
  "title": "ErrorResponseSchema",
  "type": "object",
  "properties": {
    "data": {
      "description": "Additional data that might be useful in resolving an error (see specific endpoints for details, this is used infrequently)",
      "example": {}
    },
    "message": {
      "type": "string",
      "description": "General description of the error",
      "example": "Error"
    },
    "status_code": {
      "type": "integer",
      "description": "The HTTP status code of the error"
    },
    "errors": {
      "type": "array",
      "example": [],
      "items": {
        "type": [
          "object"
        ],
        "$ref": "#/components/schemas/ValidationIssueSchema"
      }
    },
    "internal_request_id": {
      "type": "string",
      "description": "An internal tracking ID",
      "example": "550e8400-e29b-41d4-a716-446655440000"
    }
  }
}