Response

A Response has two main attributes, metadata and rawData. metadata contains the information about the response, including the status code. rawData represents the payload that will be delivered back to the client. rawData is usually, but not required to be, stringified JSON. Using an unparsed string allows for large, complex payloads to be passed around, but only parsed on demand. It also allows for non-JSON payloads if necessary.

Sample Response

{
  "metadata": {
    "responseId": "ca34277c-3c0d-41d7-b277-4383ae07d0e9",
    "code": 201,
    "status": "Created"
  },
  "rawData": "{\"uuid\":\"ea64f79d5217e57d3e9c9e857b871ccc9a909b70\"}"
}