Scribd
Upload
18 views

Exercise 6: Documenting Status Codes: Information From Developer Team

The document provides instructions for documenting HTTP status codes returned by an API in a table. It includes status code examples from the developer team - 200 for success, 401 for invalid access token, 403 for exceeded monthly request limit, and 404 for invalid resource. Learners are tasked with creating a 3-column table to list the codes, descriptions from Wikipedia, and any additional notes. Upon completion, a sample response table is available for reference.

Uploaded by

Alok Dubey
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
18 views

Exercise 6: Documenting Status Codes: Information From Developer Team

The document provides instructions for documenting HTTP status codes returned by an API in a table. It includes status code examples from the developer team - 200 for success, 401 for invalid access token, 403 for exceeded monthly request limit, and 404 for invalid resource. Learners are tasked with creating a 3-column table to list the codes, descriptions from Wikipedia, and any additional notes. Upon completion, a sample response table is available for reference.

Uploaded by

Alok Dubey
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 1

Exercise 6: Documenting Status Codes

You should already have practice documenting request and response bodies from taking the
first course on JSON and XML. So this exercise will focus on documenting the HTTP status
codes, which show success or error.

Let's say that you are working for company that has a simple API, and the status codes returned
by every request can be described in one table. For this exercise, you'll be building that table.

Information from developer team


Here is the information from the developer team with success code and what it means.

• 200. Success.
• 401. The access token is not valid for this resource.
• 403. The number of API requests per month has been exceeded.
• 404. The resource name or ID is not valid.

Create an status code table


Follow these steps:
1. Open up a word processor like Microsoft Word, Google Drive Docs, or Apple Pages.
2. Create a table with 3 columns and 5 rows.
3. On the header row, add these for the columns: Code, Description, and Notes.
4. Now fill in the rows with the information from above. The numbers go into the Code and the
descriptions go into the Notes.
5. For the Descriptions, go to the Wikipedia site that describes the HTTP status codes:
http://en.wikipedia.org/wiki/List_of_HTTP_status_codes. Find the error code and copy in the
appropriate description. For example, 401 has a description of "Unauthorized".

You can see how I did it at: http://sdkbridge.com/ud/Exercise6Answers.pdf

You might also like