Skip to content

xdev-software/sched-java-client

Repository files navigation

Latest version Build Quality Gate Status API Specification Editor

sched-java-client

Java client for the Sched API

Important

An API-Key is required for using the API.
You can get a key - if you have a payed plan - at https://insertYourConferenceHERE.sched.com/editor/exports/api

This client is generated from an openapi.yml using OpenAPI Generator.

Note

The client may look/behave odd because the Sched API violates some well established standards.

List of violations
  • Errors are (partially) returned with status code 200 (OK)
  • text/html is used as content type for plain text (should be text/plain)
  • boolean is handled as "Y"/"N" or as "0"/"1"
  • Numbers are (partially) handled as string
  • Dates are not formatted according to RFC 3339
  • Sometimes unix timestamps are used instead of dates
  • Arrays are not handled as arrays and instead comma separated lists are used
  • Some fields are not returned when using the 'Read-Only API Key' e.g. the id of users
  • Incorrect HTTP Request methods are used. E.g. GET for /api/session/del (should be DELETE)
  • Some endpoints don't return JSON by default

API Support Status

Supported endpoints
  • Site
    • Sync
  • Session
    • Add ✔️
    • Modify ✔️
    • Delete ✔️
    • List ✔️
    • Export ✔️
    • Seats
    • Count
  • User
    • List ✔️
    • Add ✔️
    • Modify ✔️
    • Get
    • Active
    • Avatar
    • Sessions
  • Auth¹
    • Login
  • Tag
    • Add
    • Modify
    • Delete
    • List
  • Going¹
    • Add
    • Delete
    • Schedule
    • All
  • Assets
    • Banner
  • Role
    • Add ✔️
    • Delete ✔️
    • Export

¹ Handles User Session Key

Installation

Installation guide for the latest release

Demo

A minimal demo is also available here.

Support

If you need support as soon as possible and you can't wait for any pull request, feel free to use our support.

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

Dependencies and Licenses

View the license of the current project or the summary including all dependencies