Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anGie44 authored Jun 5, 2022
1 parent c102db7 commit 7afdbc1
Showing 1 changed file with 9 additions and 11 deletions.
20 changes: 9 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@ Currently used for: https://angie44.github.io/theOffice

**Required:**

`season=[integer] // season number [1-9], inclusive`
* `season=[integer] // season number [1-9], inclusive`

`format=[string] // "quotes" or "connections"`
* `format=[string] // "quotes" or "connections"`

* **Success Response:**
* **Code:** 200 <br />

**Content [Quotes]:** [{ "season": _seasonNumber, "episode" : _episodeNumber, "scene": _sceneNumber,_"episode_name": _episodeName, "character": _character,_"quote" : _quote_}]

**Content [Connections]:** { "data" : [{ "episode": _episodeNumber_, "name": _episodeName_, "links" : [{ "source" : _characterName_, "target": _characterName_, "value" : _numberOfCoOccurencesInEpisode_ }], "nodes" : [{ "id" : _characterName_ }]}
* **Code:** 200
* **Content [Quotes]:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote}]`
* **Content [Connections]:** `{ "data" : [{ "episode": episodeNumber, "name": episodeName, "links" : [{ "source" : characterName, "target": characterName, "value" : numberOfCoOccurencesInEpisode }], "nodes" : [{ "id" : characterName }]}`


* Get quotes for a specific season and episode
Expand All @@ -38,11 +36,11 @@ Currently used for: https://angie44.github.io/theOffice

**Required:**

`season=[integer] // season number [1-9], inclusive`
* `season=[integer] // season number [1-9], inclusive`

`episode=[integer] // episode number within season (indexing begins at 1)`
* `episode=[integer] // episode number within season (indexing begins at 1)`
* **Success Response:**
* **Code:** 200 <br />
**Content:** [{ "season": _seasonNumber,_"episode" : _episodeNumber, "scene": _sceneNumber,_"episode_name": _episodeName, "character": _character,_"quote" : _quote_}]
* **Code:** 200
* **Content:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote }]`


0 comments on commit 7afdbc1

Please sign in to comment.