publiq Kiosks API

openapi: 3.2.0
info:
  title: Publiq Kiosks API
  version: '4.0'
  contact:
    name: publiq helpdesk
    email: technical-support@publiq.be
    url: https://docs.publiq.be
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Kiosks across 2 of this provider''s published API definitions: uitpas-uitpas.json, publiq-uitpas-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-test.uitpas.be
  description: Testing
- url: https://api.uitpas.be
  description: Production
tags:
- name: Kiosks
paths:
  /kiosks:
    parameters: []
    get:
      summary: Retrieve kiosks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KiosksPaginatedCollection'
              examples:
                Example 1:
                  value:
                    totalItems: 1
                    member:
                    - id: db385941-ece7-493d-8c4b-4320c4849646
                      name: CID-PPT-001
                      deviceId: ebee0a27-2dba-4231-aaae-15077884fa75
                      organizers:
                      - id: fd7e6177-4add-4fa8-a7fe-6e60127bfb35
                        name: CC De Schakel
                      cardSystem:
                        id: 1
                        name: UiTPAS Dender
                        branding:
                          logo: https://www.uitpas.be/_nuxt/img/1351557.svg
                          primaryColor: rgba(0,0,0,1.0)
                          secondaryColor: rgba(97,166,14,1.0)
                        links:
                          website: https://www.uitpas.be
                        cities:
                        - postalCode: '9300'
                          name: Aalst
                        - postalCode: '9400'
                          name: Ninove
                        permanent: true
                      releaseTrack: stable
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      operationId: get-kiosks
      description: 'Retrieve active kiosk devices.


        The caller of this request must have `KIOSKS_READ` permission or the caller must be an organizer admin user (any type) of the given organizer. In that case, `organizerId` is mandatory and must match the organizer of the admin user.'
      security:
      - CLIENT_ACCESS_TOKEN: []
      - USER_ACCESS_TOKEN: []
      parameters:
      - schema:
          type: string
        in: query
        name: organizerId
        description: Filter the kiosk results on this organizer
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/limit'
      tags:
      - Kiosks
    servers:
    - url: https://api-test.uitpas.be
      description: Testing
    - url: https://api.uitpas.be
      description: Production
  /kiosks/{kioskId}/fixed-event:
    parameters:
    - schema:
        type: string
      name: kioskId
      in: path
      required: true
      description: The ID of the kiosk
    get:
      summary: Retrieve fixed event of kiosk
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KioskDeviceEvent'
              examples: {}
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'Not Found. Possible error types:


            * https://api.publiq.be/probs/url/not-found (in case kiosk is not found)

            * https://api.publiq.be/probs/uitpas/event-not-found (in case no event was configured)'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: get-kiosks-kioskId-fixed-event
      description: 'Retrieve configured event of this kiosk.


        This request returns `404 NOT FOUND` when no event is configured. In that case the kiosk will auto-detect its event.


        The caller of this request must have `KIOSKS_READ` permission for the organizer of the kiosk or the caller must be an organizer admin user (any type) of the organizer of the kiosk.'
      security:
      - CLIENT_ACCESS_TOKEN: []
      - USER_ACCESS_TOKEN: []
      parameters: []
      tags:
      - Kiosks
    put:
      summary: Configure fixed event for kiosk
      operationId: put-kiosks-kioskId-fixed-event
      responses:
        '204':
          description: Updated. No Content
        '400':
          description: 'Bad Request. Possible error types:


            * https://api.publiq.be/probs/body/missing

            * https://api.publiq.be/probs/body/invalid-syntax

            * https://api.publiq.be/probs/body/invalid-data

            * https://api.publiq.be/probs/uitpas/event-not-found

            * https://api.publiq.be/probs/uitpas/event-not-acceptable'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Kiosks
      description: 'Configured event for this kiosk.


        The caller of this request must have `KIOSKS_WRITE` permission for the organizer of the kiosk or the caller must be an organizer admin user (any type) of the organizer of the kiosk.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KioskDeviceEventRequest'
        description: Kiosk event request body
      security:
      - USER_ACCESS_TOKEN: []
      - CLIENT_ACCESS_TOKEN: []
    delete:
      summary: Remove fixed event for kiosk
      operationId: delete-kiosks-kioskId-fixed-event
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'Not Found. Possible error types:


            * https://api.publiq.be/probs/url/not-found (in case kiosk is not found)

            * https://api.publiq.be/probs/uitpas/event-not-found (in case no event was configured)'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
      description: 'Remove the configured event for this kiosk.


        The caller of this request must have `KIOSKS_WRITE` permission for the organizer of the kiosk or the caller must be an organizer admin user (any type) of the organizer of the kiosk.'
      tags:
      - Kiosks
      security:
      - USER_ACCESS_TOKEN: []
      - CLIENT_ACCESS_TOKEN: []
    servers:
    - url: https://api-test.uitpas.be
      description: Testing
    - url: https://api.uitpas.be
      description: Production
components:
  responses:
    Unauthorized:
      description: 'Unauthorized. Your request is missing the required credentials to authenticate. See the Authentication documentation for more info.


        * type: https://api.publiq.be/probs/auth/unauthorized

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          x-examples:
            Unauthorized:
              value:
                type: https://api.publiq.be/probs/auth/unauthorized
                title: Unauthorized
                status: 401
    Forbidden:
      description: 'Forbidden. Your request was successfully authenticated but you do not have permission to perform this particular request.


        * type: https://api.publiq.be/probs/auth/forbidden

        * detail: might contain a developer-readable explanation of the reason'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Error'
          x-examples:
            Forbidden:
              value:
                type: https://api.publiq.be/probs/auth/forbidden
                title: Forbidden
                status: 403
                detail: user must be admin of organiser abcd1234
  schemas:
    KioskDevice:
      title: KioskDevice
      x-stoplight:
        id: hh3kfd7lxxds9
      type: object
      description: Representation of the kiosk entity
      x-examples:
        Example:
          id: db385941-ece7-493d-8c4b-4320c4849646
          name: CID-PPT-001
          deviceId: ebee0a27-2dba-4231-aaae-15077884fa75
          organizers:
          - id: fd7e6177-4add-4fa8-a7fe-6e60127bfb35
            name: CC De Schakel
          cardSystem:
            id: 1
            name: UiTPAS Dender
            branding:
              logo: https://www.uitpas.be/_nuxt/img/1351557.svg
              primaryColor: rgba(0,0,0,1.0)
              secondaryColor: rgba(97,166,14,1.0)
            links:
              website: https://www.uitpas.be
            cities:
            - postalCode: '9300'
              name: Aalst
            - postalCode: '9400'
              name: Ninove
            permanent: true
          releaseTrack: stable
      properties:
        id:
          type: string
          description: ID of the kiosk. This field is always available in responses.
          readOnly: true
        name:
          type: string
          x-stoplight:
            id: g2vr54zw4cq7o
          description: Name of the kiosk. This field is always available in responses.
          readOnly: true
        organizers:
          type: array
          description: Organizers linked to this kiosk
          items:
            $ref: '#/components/schemas/Organizer'
        locations:
          type: array
          x-stoplight:
            id: m988ozti2dcka
          description: Locations linked to this kiosk
          items:
            $ref: '#/components/schemas/Location'
        deviceId:
          type: string
          x-stoplight:
            id: 7q3dpudb6iaay
          description: Device ID linked to this kiosk.
        cardSystem:
          $ref: '#/components/schemas/CardSystem'
        releaseTrack:
          type: string
          x-stoplight:
            id: af2qu41h1ry0m
          description: Release track of this kiosk
          enum:
          - beta
          - stable
      required:
      - id
      - name
      - deviceId
      - cardSystem
      - releaseTrack
    Error:
      $ref: https://raw.githubusercontent.com/cultuurnet/apidocs/main/projects/errors/models/Error.json
    KiosksPaginatedCollection:
      title: KiosksPaginatedCollection
      type: object
      x-tags:
      - Models
      description: Paginated response object for kiosks.
      properties:
        totalItems:
          type: integer
          description: Total number of kiosk results (can be more than the amount of results in the response).
        member:
          type: array
          description: List of kiosk results for this specific (paginated) request.
          items:
            $ref: '#/components/schemas/KioskDevice'
    CardSystem:
      title: CardSystem
      description: A region, usually one or multiple municipalities in Belgium, that uses UiTPAS and provides discounts and/or rewards. For example "Paspartoe" (Brussels), UiTPAS Leuven, UiTPAS Hasselt, UiTPAS Gent, and so on.
      type: object
      x-tags:
      - Models
      example:
        id: 1
        name: UiTPAS Dender
        branding:
          logo: https://www.uitpas.be/_nuxt/img/1351557.svg
          primaryColor: rgba(0,0,0,1.0)
          secondaryColor: rgba(97,166,14,1.0)
        links:
          website: https://www.uitpas.be
        cities:
        - postalCode: '9300'
          name: Aalst
        - postalCode: '9400'
          name: Ninove
        permanent: true
      properties:
        id:
          type: integer
          description: ID of the card system
        name:
          type: string
          description: Name of the card system. This field is always available in responses.
        branding:
          type: object
          description: Branding information of the card system
          properties:
            logo:
              type: string
              description: URL to the logo of the card system
            primaryColor:
              type: string
              description: Color code of the primary branding color.
            secondaryColor:
              type: string
              description: Color code of the secondary branding color.
        links:
          type: object
          description: Links of the card system
          properties:
            website:
              type: string
              description: URL of the website of the card system
        cities:
          type: array
          description: List of cities that are part of this card system
          items:
            $ref: '#/components/schemas/City'
        permanent:
          type: boolean
          description: Indicates whether this is a permanent card system
        allowsCardlessRegistration:
          type: boolean
          description: Indicates if cardless registration is enabled
        cardlessRegistrationType:
          type: string
          description: Indicates the types of online cardless registrations this cardsystem supports.
          enum:
          - ALL
          - REGULAR
          - SOCIALTARIFF
          - NONE
        socialTariffInfo:
          type: string
          description: Optional information about social tariff entitlement in this card system.
      required:
      - id
    KioskDeviceEventRequest:
      title: KioskDeviceEventRequest
      x-stoplight:
        id: 2bfdjhsqwwxj1
      type: object
      description: Model to configure the kiosk event
      properties:
        id:
          type: string
          description: ID of the event
      required:
      - id
    Organizer:
      title: Organizer
      type: object
      description: An organisation that partners with UiTPAS to provide discounts and/or rewards, and/or allows points to be collected at their events.
      x-tags:
      - Models
      properties:
        id:
          type: string
          description: Unique ID of an UiTPAS organizer. (Same as its ID in UiTdatabank)
        name:
          type: string
          description: Human-readable name of an UiTPAS organizer.
        cardSystems:
          type: array
          description: Card systems linked to this organizer
          items:
            $ref: '#/components/schemas/CardSystem'
        linkedLocationId:
          type: string
          description: ID of the location linked to this organizer.
          readOnly: true
        address:
          type: object
          description: Address of this organizer. This property is alway available in responses.
          required:
          - city
          properties:
            street:
              type: string
              description: Street address of this organizer
            postalCode:
              type: string
              description: Postal code of this organizer
            city:
              type: string
              description: City of this organizer
          readOnly: true
      required:
      - id
    City:
      title: City
      type: object
      x-tags:
      - Models
      example:
        postalCode: '9300'
        name: Aalst
      properties:
        postalCode:
          type: string
          description: Postalcode of the city
        name:
          type: string
          description: Name of the city
      required:
      - postalCode
      - name
    Location:
      title: Location
      x-stoplight:
        id: jsek0i5fkc5ai
      type: object
      description: Location model
      properties:
        id:
          type: string
          description: ID of the location
        name:
          type: string
          x-stoplight:
            id: xqbdyntqozql8
          description: Name of the location
      required:
      - id
      - name
    KioskDeviceEvent:
      title: KioskDeviceEvent
      x-stoplight:
        id: y5atjfuzrvep1
      type: object
      description: Event model used in Kiosk APIs
      properties:
        checkinPoints:
          type: integer
          x-stoplight:
            id: b416vifd5i684
          description: Points earned when passholds checks in
        event:
          type: object
          x-stoplight:
            id: 345z9zuzxe547
          description: Current event of the kiosk.
          required:
          - id
          - title
          properties:
            id:
              type: string
              x-stoplight:
                id: 6b10ruuepsrjo
              description: ID of the event
            title:
              type: string
              x-stoplight:
                id: dxavbqgc8aysl
              description: Title of the event
        checkinCode:
          type: string
          x-stoplight:
            id: orc9gdhisu1ya
          description: Checkin code for the event
      required:
      - checkinPoints
      - event
      - checkinCode
    Error_2:
      title: Error
      type: object
      description: RFC7807 error model for all publiq APIs.
      properties:
        type:
          type: string
          description: A URI reference that identifies the problem type. Can be used to recognize specific errors in your application code by comparing the complete URI.
        title:
          type: string
          description: A short, human-readable summary of the problem type (for developers).
        status:
          type: integer
          description: The HTTP status code.
        detail:
          type: string
          description: 'A human-readable explanation specific to this occurrence of the problem (for developers). '
        endUserMessage:
          type: object
          description: A human-readable explanation of the problem, specifically for end-users, in one or more languages. Typically available for domain errors, but not for errors caused by a technical issue in the integration (for example invalid JSON syntax in a request body). An `nl` value is always provided, other languages may be provided depending on the API and its intended audience. When this property is included, it is strongly encouraged to show this to the end-user.
          properties:
            nl:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in Dutch.
            fr:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in French.
            de:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in German.
            en:
              type: string
              description: A human-readable explanation of the problem, specifically for end-users, localized in English.
          required:
          - nl
        schemaErrors:
          type: array
          description: A list of one or more schema validation errors (usually used for error type https://api.publiq.be/probs/body/invalid-data).
          items:
            type: object
            properties:
              jsonPointer:
                type: string
                format: json-pointer
                description: RFC6901 compliant pointer that indicates what property/value was invalid.
              error:
                type: string
                description: A human-readable (but often technical) reason why the property was invalid.
            required:
            - jsonPointer
            - error
      required:
      - type
      - title
      - status
      x-internal: false
  parameters:
    start:
      schema:
        type: integer
        minimum: 0
        default: 0
      in: query
      name: start
      description: Position to start returning results from. When set to `0` the results starting from the very first position will be returned. When set to for example `10` the results 0-9 will be skipped and the ones starting from position 10 will be returned. Can be used in combination with `limit` for pagination.
    limit:
      schema:
        type: integer
        default: 20
        minimum: 0
      in: query
      name: limit
      description: 'Maximum amount of results to return. Can be used in combination with `start` for pagination. **Important**: the maximum value for `limit` is `500`. Exceeding this value will result in an error.'
  securitySchemes:
    USER_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A user access token, obtained by redirecting the end user to publiq's authorization server to login using the **Authorization Code OAuth Flow**. See the [authentication docs about user access tokens](https://docs.publiq.be/docs/authentication/methods/user-access-token) for more info.
    CLIENT_ACCESS_TOKEN:
      type: oauth2
      flows: {}
      description: A client access token, obtained by exchanging your client id and client secret for a token via an HTTP request to publiq's authorization server using the **Client Credentials OAuth Flow**. See the [authentication docs about client access tokens](https://docs.publiq.be/docs/authentication/methods/client-access-token) for more info.
    CLIENT_IDENTIFICATION:
      name: x-client-id
      type: apiKey
      in: header
    CUSTOM_TOKEN:
      name: x-custom-token
      type: apiKey
      in: header
x-refined-from:
- uitpas-uitpas.json
- publiq-uitpas-openapi.yml