How To Structure Response Data?

[Jay C]

Hello,

Are there any good resources on how to properly construct response data?

For example, if I POST /emails?to=a...@a.com&from=b...@b.com&subject=test_subject

What should the response look like?

Option 1: Include the original information along with meta data all at 1 level.

{

  "id":1,

  "to":"a...@a.com",

  "from":"b...@b.com",

  "subject":"test_subject",

  "time_sent":"1234567"

}

Option 2: Separate original information and meta data.

{

  "meta": {

      "id":1,

      "time_sent":"1234567"

  },

  "email" : {

      "to":"a...@a.com",

      "from":"b...@b.com",

      "subject":"test_subject"

  }

}

Option 3: Include status with a link.

{

  "status":"success",

  "resource":"/emails/1"

}

Option 4: Something else.

[Andrew B]

SCIM (a much discussed standard of sorts) uses more or less your options 2.

Scroll down to "create request" at http://www.simplecloud.info/.

[Andrew B]

Sorry, click "See overview" first.