mirror of
https://github.com/encode/django-rest-framework.git
synced 2024-12-04 23:44:07 +03:00
220 lines
12 KiB
HTML
220 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta charset="utf-8">
|
|
<title>Django REST framework</title>
|
|
<link href="http://tomchristie.github.com/django-rest-framework/img/favicon.ico" rel="icon" type="image/x-icon">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta name="description" content="">
|
|
<meta name="author" content="">
|
|
|
|
<!-- Le styles -->
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/prettify.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/bootstrap-responsive.css" rel="stylesheet">
|
|
<link href="http://tomchristie.github.com/django-rest-framework/css/default.css" rel="stylesheet">
|
|
|
|
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
|
|
<!--[if lt IE 9]>
|
|
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<body onload="prettyPrint()" class="status-codes-page">
|
|
|
|
<div class="wrapper">
|
|
|
|
<div class="navbar navbar-inverse navbar-fixed-top">
|
|
<div class="navbar-inner">
|
|
<div class="container-fluid">
|
|
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/restframework2">GitHub</a>
|
|
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</a>
|
|
<a class="brand" href="http://tomchristie.github.com/django-rest-framework">Django REST framework</a>
|
|
<div class="nav-collapse collapse">
|
|
<ul class="nav">
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework">Home</a></li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/1-serialization">1 - Serialization</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/2-requests-and-responses">2 - Requests and responses</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/3-class-based-views">3 - Class based views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/4-authentication-permissions-and-throttling">4 - Authentication, permissions and throttling</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/5-relationships-and-hyperlinked-apis">5 - Relationships and hyperlinked APIs</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/tutorial/6-resource-orientated-projects">6 - Resource orientated projects</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/requests">Requests</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/responses">Responses</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/views">Views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/generic-views">Generic views</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/parsers">Parsers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/renderers">Renderers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/serializers">Serializers</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/fields">Serializer fields</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/authentication">Authentication</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/permissions">Permissions</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/throttling">Throttling</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/pagination">Pagination</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/content-negotiation">Content negotiation</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/format-suffixes">Format suffixes</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/reverse">Returning URLs</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/exceptions">Exceptions</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/status-codes">Status codes</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/api-guide/settings">Settings</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/csrf">Working with AJAX and CSRF</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/formoverloading">Browser based PUT, PATCH and DELETE</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/browsable-api">Working with the browsable API</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/contributing">Contributing to REST framework</a></li>
|
|
<li><a href="http://tomchristie.github.com/django-rest-framework/topics/credits">Credits</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="nav pull-right">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Version: 2.0.0 <b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">Trunk</a></li>
|
|
<li><a href="#">2.0.0</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="body-content">
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
|
|
<div class="span3">
|
|
<div id="table-of-contents">
|
|
<ul class="nav nav-list side-nav well sidebar-nav-fixed">
|
|
<li class="main"><a href="#status-codes">Status Codes</a></li>
|
|
<li><a href="#informational---1xx">Informational - 1xx</a></li>
|
|
<li><a href="#successful---2xx">Successful - 2xx</a></li>
|
|
<li><a href="#redirection---3xx">Redirection - 3xx</a></li>
|
|
<li><a href="#client-error---4xx">Client Error - 4xx</a></li>
|
|
<li><a href="#server-error---5xx">Server Error - 5xx</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="main-content" class="span9">
|
|
<p><a class="github" href="https://github.com/tomchristie/django-rest-framework/blob/restframework2/rest_framework/status.py"><span class="label label-info">status.py</span></a></p>
|
|
<h1 id="status-codes">Status Codes</h1>
|
|
<blockquote>
|
|
<p>418 I'm a teapot - Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.</p>
|
|
<p>— <a href="http://www.ietf.org/rfc/rfc2324.txt">RFC 2324</a>, Hyper Text Coffee Pot Control Protocol</p>
|
|
</blockquote>
|
|
<p>Using bare status codes in your responses isn't recommended. REST framework includes a set of named constants that you can use to make more code more obvious and readable.</p>
|
|
<pre class="prettyprint lang-py"><code>from rest_framework import status
|
|
|
|
def empty_view(self):
|
|
content = {'please move along': 'nothing to see here'}
|
|
return Response(content, status=status.HTTP_404_NOT_FOUND)
|
|
</code></pre>
|
|
<p>The full set of HTTP status codes included in the <code>status</code> module is listed below.</p>
|
|
<p>For more information on proper usage of HTTP status codes see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">RFC 2616</a>
|
|
and <a href="http://tools.ietf.org/html/rfc6585">RFC 6585</a>.</p>
|
|
<h2 id="informational-1xx">Informational - 1xx</h2>
|
|
<p>This class of status code indicates a provisional response. There are no 1xx status codes used in REST framework by default.</p>
|
|
<pre class="prettyprint lang-py"><code>HTTP_100_CONTINUE
|
|
HTTP_101_SWITCHING_PROTOCOLS
|
|
</code></pre>
|
|
<h2 id="successful-2xx">Successful - 2xx</h2>
|
|
<p>This class of status code indicates that the client's request was successfully received, understood, and accepted.</p>
|
|
<pre class="prettyprint lang-py"><code>HTTP_200_OK
|
|
HTTP_201_CREATED
|
|
HTTP_202_ACCEPTED
|
|
HTTP_203_NON_AUTHORITATIVE_INFORMATION
|
|
HTTP_204_NO_CONTENT
|
|
HTTP_205_RESET_CONTENT
|
|
HTTP_206_PARTIAL_CONTENT
|
|
</code></pre>
|
|
<h2 id="redirection-3xx">Redirection - 3xx</h2>
|
|
<p>This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request.</p>
|
|
<pre class="prettyprint lang-py"><code>HTTP_300_MULTIPLE_CHOICES
|
|
HTTP_301_MOVED_PERMANENTLY
|
|
HTTP_302_FOUND
|
|
HTTP_303_SEE_OTHER
|
|
HTTP_304_NOT_MODIFIED
|
|
HTTP_305_USE_PROXY
|
|
HTTP_306_RESERVED
|
|
HTTP_307_TEMPORARY_REDIRECT
|
|
</code></pre>
|
|
<h2 id="client-error-4xx">Client Error - 4xx</h2>
|
|
<p>The 4xx class of status code is intended for cases in which the client seems to have erred. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.</p>
|
|
<pre class="prettyprint lang-py"><code>HTTP_400_BAD_REQUEST
|
|
HTTP_401_UNAUTHORIZED
|
|
HTTP_402_PAYMENT_REQUIRED
|
|
HTTP_403_FORBIDDEN
|
|
HTTP_404_NOT_FOUND
|
|
HTTP_405_METHOD_NOT_ALLOWED
|
|
HTTP_406_NOT_ACCEPTABLE
|
|
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
|
|
HTTP_408_REQUEST_TIMEOUT
|
|
HTTP_409_CONFLICT
|
|
HTTP_410_GONE
|
|
HTTP_411_LENGTH_REQUIRED
|
|
HTTP_412_PRECONDITION_FAILED
|
|
HTTP_413_REQUEST_ENTITY_TOO_LARGE
|
|
HTTP_414_REQUEST_URI_TOO_LONG
|
|
HTTP_415_UNSUPPORTED_MEDIA_TYPE
|
|
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
|
|
HTTP_417_EXPECTATION_FAILED
|
|
HTTP_428_PRECONDITION_REQUIRED
|
|
HTTP_429_TOO_MANY_REQUESTS
|
|
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
|
|
</code></pre>
|
|
<h2 id="server-error-5xx">Server Error - 5xx</h2>
|
|
<p>Response status codes beginning with the digit "5" indicate cases in which the server is aware that it has erred or is incapable of performing the request. Except when responding to a HEAD request, the server SHOULD include an entity containing an explanation of the error situation, and whether it is a temporary or permanent condition.</p>
|
|
<pre class="prettyprint lang-py"><code>HTTP_500_INTERNAL_SERVER_ERROR
|
|
HTTP_501_NOT_IMPLEMENTED
|
|
HTTP_502_BAD_GATEWAY
|
|
HTTP_503_SERVICE_UNAVAILABLE
|
|
HTTP_504_GATEWAY_TIMEOUT
|
|
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
|
|
HTTP_511_NETWORD_AUTHENTICATION_REQUIRED
|
|
</code></pre>
|
|
</div><!--/span-->
|
|
</div><!--/row-->
|
|
</div><!--/.fluid-container-->
|
|
</div><!--/.body content-->
|
|
|
|
<div id="push"></div>
|
|
</div><!--/.wrapper -->
|
|
|
|
<footer class="span12">
|
|
<p>Sponsored by <a href="http://dabapps.com/">Dab Apps</a>.</a></p>
|
|
</footer>
|
|
|
|
<!-- Le javascript
|
|
================================================== -->
|
|
<!-- Placed at the end of the document so the pages load faster -->
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/jquery-1.8.1-min.js"></script>
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/prettify-1.0.js"></script>
|
|
<script src="http://tomchristie.github.com/django-rest-framework/js/bootstrap-2.1.1-min.js"></script>
|
|
<script>
|
|
//$('.side-nav').scrollspy()
|
|
var shiftWindow = function() { scrollBy(0, -50) };
|
|
if (location.hash) shiftWindow();
|
|
window.addEventListener("hashchange", shiftWindow);
|
|
|
|
$('.dropdown-menu').on('click touchstart', function(event) {
|
|
event.stopPropagation();
|
|
});
|
|
</script>
|
|
</body></html>
|