API
User Manual
  • Introduction to API v2
  • Guides
    • Getting started
    • Authorization
    • Delivery Notes Integrations
  • API Reference
    • General
      • Data types
        • Validation
        • Prices
      • Schema
      • Flags
      • ETags
        • ETag examples
      • Filtering
      • Sorting
      • Paging
      • Methods
      • HTTP Status Codes
    • Enums
      • Payment methods
      • Units
      • Order status
  • Entity
    • Attendance
    • Branch
    • Category
    • Cloud
    • Course
    • Customer
    • Customer Account
    • Customer Account Log
    • Daily Menu
    • Daily Menu Product
    • Delivery Note
    • Discount group
    • EET subject
    • Employee
    • Money log
    • Order
    • Order item
    • Product
    • Product Customization
    • Product Ingredient
    • Reservation
    • Stock Packaging
    • Supplier
    • Table
    • Tag
    • Tax (VAT rates)
    • Warehouse
    • Warehouse Branch
  • Others
    • Reports
      • Base Sales Report
    • POS actions
    • Release notes
    • Breaking changes
    • Webhook
    • Third-party libraries
  • Migration
    • Migrating from API v1
    • API v1 Services
      • Branch Service
      • Category Service
      • Customer Service
      • Employee Service
      • OAuth2 Login Service
      • POS action service
      • Product Service
      • Reservation Service
      • Sale Service
      • Stock Service
      • Supplier Service
      • Tableseat Service
      • Tag Service
      • Warehouse Service
Powered by GitBook
On this page
  • Course schema
  • JSON response
  • Get courses
  • Get course

Was this helpful?

Export as PDF
  1. Entity

Course

PreviousCloudNextCustomer

Last updated 3 years ago

Was this helpful?

Course schema

id long? Course ID - cannot be null in PUT/PATCH methods 📶 EQUALS,ENUM

_cloudId integer 🔽 NONE

deleted boolean Cannot be true in POST/PUT/PATCH methods 📶 EQUALS,ENUM

enabled boolean Enable course

name string(1, ...) Course name 📶 STRING 🔽 BOTH

sortOrder long Value for order (sorting) courses.

tags string[] Tags for a courses

versionDate timestamp? Last modification date and time 📶 EQUALS,ENUM,NUMBER

JSON response

{
    "_cloudId": <integer>,
    "deleted": <boolean>,
    "enabled": <boolean>,
    "id": <long>,
    "name": <string>,
    "sortOrder": <long>,
    "tags":<string[]>,
    "versionDate": <timestamp>
}

Get courses

GET https://api.dotykacka.cz/v2/clouds/:cloudId/courses

Path Parameters

Name
Type
Description

cloudId*

integer

Query Parameters

Name
Type
Description

sort

string

page

integer

filter

string

limit

integer

Headers

Name
Type
Description

Authorization*

string

Bearer accessToken

[
    {
        Entity response schema
    },
    ...
]

Get course

GET https://api.dotykacka.cz/v2/clouds/:cloudId/courses/:courseId

Path Parameters

Name
Type
Description

cloudId*

Integer

Cloud ID