TheCloneArmy/RestApiGuide
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated restquicktips.html and httpstatuscodes.html

Browse Source
This commit is contained in:
Todd Fredrich
2014-02-03 16:33:21 -07:00
parent 033fa31cde
commit 933e982cf7
3 changed files with 86 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
httpstatuscodes.html
View File

@ -147,7 +147,7 @@
<p>The 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields.</p>
<h3>Wikipedia</h3>
<p>The server successfully processed the request, but is not returning any content.</p>
<p><i class="icon-star"></i> Status when wrapped responses (e.g. JSEND) are not used and nothing is in the body (e.g. DELETE).</p>
<p><i class="icon-star"></i> Indicates success but nothing is in the response body, often used for DELETE and UPDATE operations.</p>
</div>
</div>
<div class="span4">
@ -270,7 +270,7 @@
</div>
</div>
<div class="span4">
<i class="icon-star"></i> <a data-toggle="collapse" data-target="#not_modified" href="#">304 Not Modified</a>
<a data-toggle="collapse" data-target="#not_modified" href="#">304 Not Modified</a>
<div id="not_modified" class="collapse">
<p>If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.</p>
<p>The response MUST include the following header fields:</p>
@ -287,7 +287,6 @@
<p>If a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response.</p>
<h3>Wikipedia</h3>
<p>Indicates the resource has not been modified since last requested. Typically, the HTTP client provides a header like the If-Modified-Since header to provide a time against which to compare. Using this saves bandwidth and reprocessing on both the server and client, as only the header data must be sent and received in comparison to the entirety of the page being re-processed by the server, then sent again using more bandwidth of the server and client.</p>
<p><i class="icon-star"></i> Used for conditional GET calls to reduce band-width usage. If used, must set the Date, Content-Location, ETag headers to what they would have been on a regular GET call. There must be no body on the response.</p>
</div>
</div>
<div class="span4">
@ -386,11 +385,12 @@
</div>
</div>
<div class="span4">
<a data-toggle="collapse" data-target="#method_no_allowed" href="#">405 Method Not Allowed</a>
<i class="icon-star"></i> <a data-toggle="collapse" data-target="#method_no_allowed" href="#">405 Method Not Allowed</a>
<div id="method_no_allowed" class="collapse">
<p>The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource.</p>
<h3>Wikipedia</h3>
<p>A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.</p>
<p><i class="icon-star"></i> Used to indicate that the requested URL exists, but the requested HTTP method is not applicable. For example, <em>POST /users/12345</em> where the API doesn't support creation of resources this way (with a provided ID). The Allow HTTP header must be set when returning a 405 to indicate the HTTP methods that are supported. In the previous case, the header would look like &quot;Allow: GET, PUT, DELETE&quot;</p>
</div>
</div>
</div>
@ -651,7 +651,7 @@
<p>The server encountered an unexpected condition which prevented it from fulfilling the request.</p>
<h3>Wikipedia</h3>
<p>A generic error message, given when no more specific message is suitable.</p>
<p><i class="icon-star"></i> The general catch-all error when the server-side throws an exception.</p>
<p><i class="icon-star"></i> The general catch-all error when the server-side throws an exception. Use this only for errors that the consumer cannot address from their end&mdash;never return this intentionally.</p>
</div>
</div>
<div class="span4">