Skip to content

Latest commit

 

History

History
158 lines (137 loc) · 3.32 KB

response-objects.md

File metadata and controls

158 lines (137 loc) · 3.32 KB
Raw

Response Objects

In regards to: RFC 7807 Problem Details


Non paginated OK Request (200)

{
  "data": {
    "id": 2,
    "firstName": "Slacquer",
    "lastName": McLoven",
    "birthDate": "1971-10-12T00:00:00+00:00",
    "locations": null
  }
}


Paginated Ok Request (200)

{
  "data": [
    {
      "id": 1,
      "firstName": "Slacquer 0",
      "lastName": "McLoven 0",
      "birthDate": "1971-10-12T00:00:00+00:00",
      "locations": null
    },
    {
      "id": 2,
      "firstName": "Slacquer 1",
      "lastName": "McLoven 1",
      "birthDate": "1971-11-12T00:00:00+00:00",
      "locations": null
    },
    {
      "id": 3,
      "firstName": "Slacquer 2",
      "lastName": "McLoven 2",
      "birthDate": "1971-12-12T00:00:00+00:00",
      "locations": null
    }
  ],
  "pagination": {
    "runningCount": 0,
    "next": "https://foo.com/nextPage?$skip=10&top=10&runningCount=5",
    "previous": "https://foo.com/firstPage?top=10"
  }
}


All NON-successful responses follow this structure.

{
  "error": {
    "detail": "Short detailed summary of the problem",
    "errors": [
      {
        "detail": "Short detailed summary of the problem.",
        "title": "Consistent Title"
      }
    ],
    "instance": "A URI reference that identifies the specific occurrence of the problem ",
    "status": HttpStatus code,
    "title": " A short, human-readable summary of the problem type ",
    "type": " A URI reference that identifies the problem type "
  }
}


POST, validation error example
Unauthorized (401)

{
  "detail": "Please see errors property for more details",
  "errors": [
    {
      "detail": "Example detail",
      "title": "You are not authenticated, meaning not authenticated at all or authenticated incorrectly."
    }
  ],
  "instance": "[request url]",
  "status": 401,
  "title": "Un-authorized",
  "type": "https://httpstatuses.com/401"
}


NON PRDOUCTION SERVER FAULT STRUCTURE
Server Error (500)

{
    "error": {
      "detail": "Please refer to the error property for additional information.",
      "errors": [
        {
          "detail": "Some root level exception",
          "errors": [
            {
              "detail": "Specified argument was out of the range of valid values”
              "title": "Error Details",
              "type": "ArgumentOutOfRangeException"
            }
          ],
          "title": "Please refer to the error property for additional information.",
          "type": "Exception"
        }
      ],
      "instance": "/api/qa/people",
      "referenceId": "1110183247",
      "status": 500,
      "title": "An internal server error has occured.",
      "type": "about:blank"
    }
  }


PRDOUCTION SERVER FAULT STRUCTURE
Server Error (500)
Note that the NON-Production fault would be logged, just not sent back in the response. This could be done just like NON-prod if used in a public API.

{
    "error": {
      "detail": "Please contact support.",
      "instance": "/api/qa/people",
      "referenceId": "1110183247",
      "status": 500,
      "title": "An internal server error has occured.",
      "type": "about:blank"
    }
  }