publiq Visits API

openapi: 3.2.0
info:
  title: museumPASSmusées Partner Visits API
  version: '1.0'
  description: With the museumPASSmusées Partner API you can look up the card of a passholder and check if they are allowed to visit your museum and register their visit so your museum gets reimbursed for it.
  contact:
    name: publiq helpdesk
    email: technical-support@publiq.be
    url: https://docs.publiq.be
servers:
- url: https://partner-api-test.museumpassmusees.be
  description: Testing
- url: https://partner-api.museumpassmusees.be
  description: Production
tags:
- name: Visits
paths:
  /visits:
    post:
      summary: Register a museum visit
      operationId: post-visits
      responses:
        '201':
          description: Visit registered.
        '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/museumpass/passholder-not-found

            - https://api.publiq.be/probs/museumpass/visit-maximum-reached

            - https://api.publiq.be/probs/museumpass/museum-not-active

            - https://api.publiq.be/probs/museumpass/card-not-active

            - https://api.publiq.be/probs/museumpass/subscription-not-active

            - https://api.publiq.be/probs/museumpass/passholder-not-active'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      description: 'Registers a visit of a passholder at your museum (determined by the client access token used).


        To retrieve the `passholderId` of a passholder, look up their pass using `GET /passes/{cardNumber}`. The response to that request will also indicate if the passholder may visit your museum.


        If the passholder may not visit your museum and you still try to register a visit for them, the server will return a `403 Forbidden` error response.


        ## Permissions


        The caller of this request must have the `visit registrar` role.'
      security:
      - CLIENT_ACCESS_TOKEN: []
      requestBody:
        description: New museum visit.
        content:
          application/json:
            schema:
              type: object
              properties:
                passholderId:
                  type: string
                  description: ID of the passholder that visits the museum
              required:
              - passholderId
            examples:
              Example:
                value:
                  passholderId: a6c002ca-41ee-4e02-9558-1bead1b54ebc
      tags:
      - Visits
components:
  schemas:
    Error:
      $ref: https://raw.githubusercontent.com/cultuurnet/apidocs/main/projects/errors/models/Error.json
      x-internal: true
  responses:
    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'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/forbidden
                title: Forbidden
                status: 403
                detail: user must be admin of organizer abcd1234
    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'
          examples:
            Example:
              value:
                type: https://api.publiq.be/probs/auth/unauthorized
                title: Unauthorized
                status: 401
  securitySchemes:
    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.