Object structure of JSON API 1.0

jsonapi-response-structure.md

JSON API Object Structure

Format: JSON API 1.0

This is a structure of all objects in a JSON API response body. This document will be used to build a JSON API Client in PHP. Please leave me a comment if there is something wrong or missing.

Note: This document covers only a possible JSON API response body. A request body can have some exceptions.

Symbols

Symbol	Description
1	at least one of these properties is required
*	zero, one or more properties
+	required
-	optional
!	not allowed

All objects

1. Document object
2. Resource Identifier object
3. Resource object
4. Attributes object
5. Relationship Collection object
6. Relationship object
7. Error object
8. Error Source object
9. Link object
10. Document Link object
11. Relationship Link object
12. Error Link object
13. Pagination Link object
14. Jsonapi object
15. Meta object

Document object

• extends:
• extended by:
• property of:

Properties

| Name | Value | Note

--- | ---- | ----- | ---- 1 | data | - null
- Resource Identifier object
- Resource object
- array()
- array(Resource Identifier object)
- array(Resource object) | not allowed, if 'errors' exists 1 | errors | array(Error object) | not allowed, if 'data' exists 1 | meta | Meta object |

• | jsonapi | Jsonapi object |
• | links | Document Link object |
• | included | array(Resource object) | not allowed, if 'data' doesn't exist

Resource Identifier object

• extends:
• extended by: Resource object
• property of:
  • Document object
  • Relationship object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | type | string |
• | id | string |

• | meta | Meta object |

Resource object

• extends: Resource Identifier object
• extended by:
• property of: Document object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | attributes | Attributes object |
• | relationships | Relationship Collection object |
• | links | Link object |

Attributes object

• extends: Meta object
• extended by:
• property of: Resource object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | string | mixed | ! | type | | already used in Resource object | ! | id | | already used in Resource object | ! | relationships | | reserved by spec for future use | ! | links | | reserved by spec for future use |

Relationship Collection object

• extends:
• extended by:
• property of: Resource object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | string | Relationship object | not allowed, if already used in parents Attributes object property) ! | type | | already used in Resource object ! | id | | already used in Resource object

Relationship object

• extends:
• extended by:
• property of: Relationship Collection object

Properties

| Name | Value | Note

--- | ---- | ----- | ---- 1 | links | Relationship Link object | 1 | data | - null
- Resource Identifier object
- array()
- array(Resource Identifier object) | 1 | meta | Meta object |

Error object

• extends:
• extended by:
• property of: Document object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | id | string |
• | links | Error Link object |
• | status | string |
• | code | string |
• | title | string |
• | detail | string |
• | source | Error Source object |
• | meta | Meta object |

Error Source object

• extends:
• extended by:
• property of: Error object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | pointer | string |
• | parameter | string |

Link object

• extends:
• extended by:
  • Document Link object
  • Relationship Link object
  • Error Link object
  • Pagination Link object
• property of:
  • Resource object
  • Link object
  • Error Link object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | string | - string
  - Link object |

• | href | string |
• | meta | Meta object |

Document Link object

• extends: Link object
• extended by:
• property of: Document object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | self | string |
• | related | string |
• | pagination | Pagination Link object |

Relationship Link object

• extends: Link object
• extended by:
• property of: Relationship object

Properties

| Name | Value | Note

--- | ---- | ----- | ---- 1 | self | string | 1 | related | string |

• | pagination | Pagination Link object | Only exists if the parent relationship object represents a to-many relationship

Error Link object

• extends: Link object
• extended by:
• property of: Error object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | about | - string
  - Link object |

Pagination Link object

• extends: Link object
• extended by:
• property of:
  • Document Link object
  • Relationship Link object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | first | - null
  - string |
• | last | - null
  - string |
• | prev | - null
  - string |
• | next | - null
  - string |

Jsonapi object

• extends:
• extended by:
• property of: Document object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | version | string | Default: "1.0"
• | meta | Meta object |

Meta object

• extends:
• extended by: Attributes object
• property of:
  • Document object
  • Resource Identifier object
  • Relationship object
  • Error object
  • Link object
  • Jsonapi object

Properties

| Name | Value | Note

--- | ---- | ----- | ----

• | string | mixed |