ResponseTrait.php

Provides a single, simple method to return an API response, formatted to match the requested format, with proper content-type and status code.

Used for generic failures that no custom methods exist for.

Used after successfully creating a new resource.

Used after a resource has been successfully deleted.

Used after a resource has been successfully updated.

Used after a command has been successfully executed but there is no meaningful reply to send back to the client.

Used when the client is either didn't send authorization information, or had bad authorization credentials. User is encouraged to try again with the proper information.

Used when access is always denied to this resource and no amount of trying again will help.

Used when a specified resource cannot be found.

Used when the data provided by the client cannot be validated on one or more fields.

Use when trying to create a new resource and it already exists.

Use when a resource was previously deleted. This is different than Not Found, because here we know the data previously existed, but is now gone, where Not Found means we simply cannot find any information about it.

Used when the user has made too many requests for the resource recently.

Used when there is a server error.

Handles formatting a response. Currently, makes some heavy assumptions and needs updating! :)

Sets the format the response should be in.