Skip to content

Endpoints for v4 #4

Description

@Matix-Media

Following endpoints are required:

User:

  • POST /api/v4/user/create Create a user
  • PATCH /api/v4/user/change Modify user
  • DELETE /api/v4/user/delete Delete user
  • GET /api/v4/user Get a list of all users
  • GET /api/v4/user/:id Get user by id
  • GET /api/v4/user/:user_class_name Get a list of users with specific class
  • GET /api/v4/user?query Get user by name (firstname, lastname, or both - full names are separated by space (%20))
  • GET /api/v4/user/:id/history Get a list of the last bookings including current ones
  • GET /api/v4/user?booking=true Get a list of user, that are currently booking devices

User-Class:

  • POST /api/v4/user/class/create Create a class
  • PATCH /api/v4/user/class/change Modify class
  • DELETE /api/v4/user/class/delete Delete class
  • GET /api/v4/user/class Get a list of all classes
  • GET /api/v4/user/class/:id Get class by id
  • GET /api/v4/user/class?query= Get class by class name

Device:

  • POST /api/v4/device/create Create a device
  • PATCH /api/v4/device/change Modify device
  • DELETE /api/v4/device/delete Delete device
  • GET /api/v4/device Get a list of all devices
  • GET /api/v4/device/:id Get device by id
  • GET /api/v4/device/:uid Get device by uid
  • GET /api/v4/device/:device_type_name Get a list of devices with a specific type
  • GET /api/v4/device/:id/history Get a list of user by id that booked the device including the dates
  • GET /api/v4/device/:uid/history Get a list of user by uid that booked the device including the dates
  • GET /api/v4/device?booking=true Get a list of booked devices

Device-Type:

  • POST /api/v4/device/type/create Create a device type
  • PATCH /api/v4/device/type/change Modify device type
  • DELETE /api/v4/device/type/delete Delete device type
  • GET /api/v4/device/type Get a list of all device types
  • GET /api/v4/device/type/:id Get device type by type id
  • GET /api/v4/device/type?query= Get device type id by device type name

Usercard:

  • POST /api/v4/usercard/create Create a usercard
  • PATCH /api/v4/usercard/change Modify usercard
  • DELETE /api/v4/usercard/delete Delete usercard
  • GET /api/v4/usercard Get a list of all usercards
  • GET /api/v4/usercard/:id Get usercard by id
  • GET /api/v4/usercard/:uid Get usercard by uid
  • GET /api/v4/usercard/:usercard_type_name Get a list of usercards with specific type

Usercard-Type:

  • POST /api/v4/usercard/type/create Create a usercard type
  • PATCH /api/v4/usercard/type/change Modify usercard type
  • DELETE /api/v4/usercard/type/delete Delete usercard type
  • GET /api/v4/usercard/type Get a list of all usercard types
  • GET /api/v4/usercard/type/:id Get usercard type by type id
  • GET /api/v4/usercard/type?query= Get usercard type id by usercard type name

Token:

  • POST /api/v4/token/create Create a token
  • DELETE /api/v4/token/delete Delete token
  • GET /api/v4/token Get a list of all tokens
  • GET /api/v4/token/:id Get token by id
  • GET /api/v4/token?username= Get token by username
  • GET /api/v4/token/validate Check whether token is valid or not
  • POST /api/v4/token/authorize Get token with username and password (params: username, password)

Token-Permission:

  • GET /api/v4/token/permission Get a list of all permissions
  • GET /api/v4/token/permission/:id Get name and description of token by id
  • GET /api/v4/token/permission?query= Get permission id by name

Csv:

  • POST /api/v4/csv import csv data into database

Options for GET endpoints:

  • page= and size= set the amount of results and shift with page (page by default 0)
  • strict= if true, the search will be limited to 100% accordance, but its not case sensitive

Most requests will be available only from version 4 and newer

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions