This documentation is structured by API endpoints, which is a specific method within that API that performs one action and is located at a specific URL.

Each endpoint in this documentation is described using several parts:

  • HTTP Method
  • Path
  • Header parameters
  • URL parameters
  • Query parameters
  • Body parameters

All URLs referenced in the documentation have the root path This base path goes before the endpoint path:

In this example combine the base path and /member/{VATSIM_ID} to get the request URL:{VATSIM_ID}

For this endpoint, {VATSIM_ID} is the URL parameter. In a request, you replace the placeholder {VATSIM_ID} with a real value:

More details are provided in endpoint references.