Get event by ID

GET 
/view/:eventId

Returns the event with the specified ID.

Request

Path Parameters

eventId integer
Event ID
Example: 1

Responses

200

Successful operation

application/json

Schema

Schema

data object

id integer

Event ID

type string

Possible values: [Event, Controller Examination, VASOPS Event]

Event type

name string

Event name

link string

Event link

organisers object[]

Event organisers

Array [

region stringnull

Region ID

division stringnull

Division ID

subdivision stringnull

Subdivision ID

organised_by_vatsim boolean

Whether the event is organised by VATSIM

]

airports object[]

Event airports

Array [

icao string

Airport ICAO code

]

routes object[]

Event routes

Array [

departure string

Departure airport ICAO code

arrival string

Arrival airport ICAO code

route string

Prescribed route

]

start_time date-time

Event start time

end_time date-time

Event end time

short_description string

Event short description (Markdown)

description string

Event description (Markdown)

banner string

Event banner

Example (from schema)

{
  "data": {
    "id": 1,
    "type": "Event",
    "name": "Example Event",
    "link": "https://my.vatsim.net/events/example-event",
    "organisers": [
      {
        "region": "AMAS",
        "division": "USA",
        "subdivision": null,
        "organised_by_vatsim": false
      }
    ],
    "airports": [
      {
        "icao": "KJFK"
      }
    ],
    "routes": [
      {
        "departure": "KJFK",
        "arrival": "KATL",
        "route": "RBV Q430 BYRDD J48 MOL FLASK OZZZI1"
      }
    ],
    "start_time": "1970-01-01T00:00:00.000000Z",
    "end_time": "1970-01-01T06:00:00.000000Z",
    "short_description": "Fly with us tonight!",
    "description": "Fly with us tonight!",
    "banner": "https://vatsim-my.nyc3.digitaloceanspaces.com/events/JpjoYKp6CRcz4V1wvdlMnQHiAtYOmT2p3DevEA7j.png"
  }
}

404

application/json

Schema

Schema

success string

Status of the request

message string

Error message

Example (from schema)

{
  "success": "not_found",
  "message": "event could not be found"
}

Loading...