Skip to content

Instantly share code, notes, and snippets.

@lieselta lieselta/apidoc.md
Last active Jan 19, 2019

Embed
What would you like to do?

Gander Oceanic API Documentation

Basic Info

The API is used by sending GET requests which return JSON responses. There is no authentication. Example: https://czqo.vatcan.ca/api/news/articles would return:

[
  {
    "id": 1,
    "title": "Gander Oceanic Website Open Beta",
    "content": "Hi everyone! The Gander Oceanic website is still in an OPEN BETA status. This means that there *will* be bugs present. Please make sure you report these via a ticket.",
    "date": "2019-01-12",
    "type": "NoEmail",
    "user_id": "1364284",
    "archived": "0",
    "created_at": "2019-01-12 17:37:10",
    "updated_at": "2019-01-12 17:37:10"
  }
]

Basic data definitions:

Id: Id of the object in the database

User_id: ID of the user responsible for the creation of the object respresented by CID.

News

All articles

/api/news/all Returns JSON with all news articles including news and controller certifications.

Controller certifications

/api/news/certifications Returns JSON with all controller certifications.

Articles

/api/news/articles Returns JSON with only articles.

Controller certification

VNAS

/api/users/{cid}/vnas {cid} = VATSIM CID Returns raw text 'true' or 'false' depending if approved for Gander or not. True obviously meaning yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.