---
title: "ErrorResponse"
url: "https://apiportal-ppd.np.six-group.com/apis/eam-public-v1-api-az-ch-preprod-v1/versions/46a433cc-2c51-4d40-83e4-c9868fcbc0b0/schemas/ErrorResponse"
---

> Full API specification: https://apiportal-ppd.np.six-group.com/apis/eam-public-v1-api-az-ch-preprod-v1/versions/46a433cc-2c51-4d40-83e4-c9868fcbc0b0.md

# ErrorResponse

Canonical error payload as defined in the SIX Group REST API Guidelines.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: EAM API
  version: 0.0.1
servers:
  - url: https://api-preprod.np.azure.six-group.com:8443/eal/ext/v1
components:
  schemas:
    InvalidParam:
      type: object
      properties:
        in:
          type: string
          description: Location of the invalid parameter.
          enum:
            - BODY
            - PATH
            - QUERY
            - HEADER
        name:
          type: string
          description: Name of the invalid parameter.
        reason:
          type: string
          description: Why the parameter value is invalid.
        value:
          type:
            - string
            - "null"
          description: The rejected value. May be null when unsafe to echo back.
      required:
        - in
        - name
        - reason
    ErrorResponse:
      type: object
      description: Canonical error payload as defined in the SIX Group REST API Guidelines.
      properties:
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 UTC timestamp of when the error was produced.
        status:
          type: integer
          description: HTTP status code (RFC 7231 6).
        code:
          type: string
          description: Machine-readable application-specific error code (e.g.
            RESOURCE_NOT_FOUND).
        message:
          type: string
          description: Human-readable summary of the problem.
        path:
          type:
            - string
            - "null"
          description: Request path that produced the error. Optional.
        traceId:
          type:
            - string
            - "null"
          description: W3C trace ID (32-char lowercase hex) for correlation.
        invalidParams:
          type: array
          description: Parameters whose values failed validation. Omitted when empty.
          items:
            $ref: "#/components/schemas/InvalidParam"
      required:
        - message
        - status
        - timestamp
```
