Template API

Published on the 25th of April | Takes about 7 minutes to read.

How does the Template API work?

What do you mean with Template?

Our template functionality offers users to make a template of a week of events. This template will repeat itself every week. With our system, you can make easy adjustments to the template. This page is dedicated to our API, which handles requests such as requesting the weekly template and inserting said events.

What are the advantages?

An API allows people to make their own applications which interact with others. In our case, we can allow users to use our API to request their schedule in a .json format which they can use to create their own programs. This is extremely useful for programmers but doesn't offer much to standard users.

Template API Documentation

Our API responds with .json files. Accessing the Template API goes trough api.netwerkadf.eu/booket/template/. You are required to use POST. The API also expects the api-key and action as form-data.

• Usage

  These two are always required. Hover over any key and variables for information.

  {
      "api-key": "API key",
      "action": {
          "help": "Show you basic help",
          "ping": "pongs",
          //Requestable data | THESE DON'T REQUIRE ANY EXTRA PARAMETERS!
          "getTemplate": "Gets all template data.",
          "getOverride": "Gets all override data.",
          "getGroups": "Gets all templategroup data.",
          "getRooms": "Gets all assignedrooms data.",
          //Insert commands.
          "override": "Create an override event | unusable by others",
          "insertTemplate": "Insert into the template table | unusable by others ",
          "assignRoom": "Assign rooms to a group | unusable by others",
          "assignGroup": "Assign rooms to a group INTO __templategroup__. Groups use this action!"
      },
      //Hover to check which actions require these vars
      "templateid": "int",
      "groupid": "int",
      "spotid": "int",
      "start": "12:34:56",
      "end": "12:34:56",
      "name": "string",
      "info": "string",
      "day": "int",
      "date": "2020-07-01"
  }