• Responses
  • Success response
    • status_code: 200
    • data
      • format: json
      • fields:
        • message: describes the operation
        • data: the object in the new state
  • Generic client error
    • status_code: 400
    • data
      • format: json
      • fields:
        • message: the error message
        • data: null
  • Permission error
    • status_code: 401
    • data
      • format: json
      • fields:
        • message: describes the issue
        • data: null
  • Not found error
    • status_code: 404
    • data
    • format: json
      • fields:
        • message: describes the failure
        • data: null
  • Validation error
    • status_code: 422
    • data
    • format: json
      • fields:
        • message: "Validation error"
        • data (array of objects)
          • path: the path to the key(s)
          • key: array of keys
          • constraint: the name of the constraint
          • description: the description of the constraint
  • Generic server error
    • status_code: 500
    • data
      • format: json
      • fields:
        • message: the error message
        • data: null

Back to Index