https://github.com/angie44/theoffice-api

an api to retrieve the Office (US) quotes and character co-occurrence data when needed (ALWAYS XD)
https://github.com/angie44/theoffice-api

golang lolz rest the-office

Last synced: 24 days ago
JSON representation

an api to retrieve the Office (US) quotes and character co-occurrence data when needed (ALWAYS XD)

• Host: GitHub
• URL: https://github.com/angie44/theoffice-api
• Owner: anGie44
• Created: 2017-09-17T06:11:31.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-11-11T19:29:58.000Z (about 1 year ago)
• Last Synced: 2024-03-15T20:05:17.693Z (8 months ago)
• Topics: golang, lolz, rest, the-office
• Language: Go
• Homepage: https://the-office.fly.dev
• Size: 73.2 KB
• Stars: 24
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# theOffice-api

a REST api to retrieve the Office quotes when needed (ALWAYS 💁‍)

Currently hosted at: https://the-office.fly.dev

Currently used for: https://angie44.github.io/theOffice

![](https://media.giphy.com/media/MaItK5SUgStdm/giphy.gif)

# API Reference

Available at: https://the-office.fly.dev/docs

## GET 

* Get quotes or nodes/links by season number

    * **URL:**           _/season/:season/format/:format_

    * **Method:**       `GET`

    * **URL Params:**

    

         **Required:**

         

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

         

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

     * **Success Response:**

       * **Code:** 200

       * **Content [Quotes]:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote}]`

       * **Content [Connections]:** `[{ "episode": episodeNumber, "name": episodeName, "links" : [{ "source" : characterName, "target": characterName, "value" : numberOfCoOccurencesInEpisode }], "nodes" : [{ "id" : characterName }]`

        

   

* Get quotes for a specific season and episode

    * **URL:**          _/season/:season/episode/:episode_

    * **Method:**       `GET`

    * **URL Params:**

    

         **Required:** 

         

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

         

         * `episode=[integer] // episode number within season (indexing begins at 1)`

    * **Success Response:**

      * **Code:** 200

      * **Content:** `[{ "season": seasonNumber, "episode" : episodeNumber, "scene": sceneNumber, "episode_name": episodeName, "character": character, "quote" : quote }]`