HTTP Verbs

Owned by Ian Christopher
Jun 20, 2017
2 min read

HTTP verbs communicate actions that can be taken against a resource. Depending on the verb, the request can require additional information in the body. The Ed-Fi REST API supports the following verbs:

  • POST An HTTP POST creates an individual subordinate resource. If successful, the URI to the new resource is returned in the “Location” HTTP header of the response. Performing a POST with identical natural keys to a resource already in the data store must perform an update rather than create a new resource. A POST operation must not allow a desired unique ID (UUID) to be provided to the REST API. POST is a required verb for non-read-only Resources.
  • GET An HTTP GET returns existing Resources. Providing the natural key or internal UUID on the URL specifies an individual resource, while omitting the natural keys and UUID retrieves the complete set of Resources of the given type. GET must be an idempotent operation. GET is a required verb.
  • PUT An HTTP PUT must perform an idempotent update of an existing resource. PUT performs a full replacement of the existing resource with the supplied value. A PUT against a nonexistent resource will create a new resource under the provided UUID. PUT is a required verb for non-read-only Resources.
  • DELETE An HTTP DELETE deletes an existing individual resource. DELETE is a required verb for non-read-only Resources.
  • PATCH An HTTP PATCH performs a partial update on an existing individual resource. For a partial update, only the properties that are submitted will be updated on the target resource. The entire patch will be applied, or none of it will. The new representation of the entire resource is returned in the response body. PATCH is a recommended verb for non-read-only Resources.