When returning a single item

Below is the general structure of the data returned from the endpoint

{
  data: //The data of the item
  operations: {
	  operationName1: {
	  // Details of operation 1
		  url: "the url to perform the action",
		  // additional restrictions
	  },
	  operationName2: {
	  // Details of operation 2
		  url: "the url to perform the action",
		  // additional restrictions
	  }
  }
}

• data field contains the data requested
• operations field optionally contains what operations (endpoints)
  • This field is optional; if it is not provided, then no operations can be performed on this item
  • Each field of the operations object:
    • Contains the unique key representing what operations can be performed on this data
      • A link to the URL in the url field
      • Additional constraints (such as until when the request can be made) or other information that would be beneficial

When returning a list of data

Below is the general structure of the data when a list of data is returned from the endpoint

{
  data: [
   // List of objects that all follow the pattern of the single returned item above
  ],
  operations: {
	  // Examples below
    next: {
	    url: "endpoint to get the next data if pagination is used",
    },
    previous: {
	    url: "endpoint to get the previous data if pagination is used",
    },
  },
}

• The data field contains the list of objects that follow the structure of the “When returning a single item above”
• operations
  • Not provided if no operations can be performed on the data
  • Each field in this object contains a unique key for the operation that can be performed
  • next field exists if the data was requested via pagination, and can get the next set of items. Doesn’t exist if can’t get the next set of data
  • previous field exists if the data was requested via pagination, and can get the previous set of items. Doesn’t exist if can’t get the previous set of data
  • More field than the previous and next can exist
  • All fields in this object contain a url for the endpoint that can be performed