Venue Manager shop API - VenueApp

VenueApp specific endpoints for the Venue Manager shop platform.

Links to the other modules’ endpoints can be found at http://docs.api.venuemanager.net/.

Home screen ¶

Functionality related to the app home screen.

Home ¶

Home
GET`/home`

List of elements to be displayed on the Venue App home page.

This will include the next event with the “show in app” attribute enabled in the admin, along with contents from the VenueApp admin module.

The list will be sorted.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/home

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "nextgame": {
      "id": 12,
      "seasonId": 1,
      "type": "league",
      "title": "Mors-Thy - HC Midtjylland",
      "startTime": "2017-08-05T12:30:00+02:00",
      "endTime": "2017-08-05T19:30:00+02:00",
      "venue": "Jyske Bank Mors Arena",
      "address": "4900 Marie P DeBartolo Way",
      "latitude": 37.403,
      "longitude": -121.97,
      "backgroundImage": "https://firebasestorage.googleapis.com/v0/b/combineappversion.appspot.com/o/morsmthaarhus.jpg?alt=media",
      "url": "http://shop.name/path/to/event/",
      "homeTeam": {
        "name": "San Francisco 49ers",
        "shortName": "SF",
        "logo": ": http://placehold.it/400x400"
      },
      "guestTeam": {
        "name": "San Francisco 49ers",
        "shortName": "SF",
        "logo": ": http://placehold.it/400x400"
      }
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Events ¶

Events
GET`/events`

List of all upcoming events with the “show in app” enabled in the admin

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/events

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 12,
    "seasonId": 1,
    "type": "league",
    "title": "Mors-Thy - HC Midtjylland",
    "startTime": "2017-08-05T12:30:00+02:00",
    "endTime": "2017-08-05T19:30:00+02:00",
    "venue": "Jyske Bank Mors Arena",
    "address": "4900 Marie P DeBartolo Way",
    "latitude": 37.403,
    "longitude": -121.97,
    "backgroundImage": "https://firebasestorage.googleapis.com/v0/b/combineappversion.appspot.com/o/morsmthaarhus.jpg?alt=media",
    "url": "http://shop.name/path/to/event/",
    "homeTeam": {
      "name": "San Francisco 49ers",
      "shortName": "SF",
      "logo": ": http://placehold.it/400x400"
    },
    "guestTeam": {
      "name": "San Francisco 49ers",
      "shortName": "SF",
      "logo": ": http://placehold.it/400x400"
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Customer Products ¶

Products ¶

Products
GET`/products?clientName={clientName}&clientOs={clientOs}`

Returns the products owned by the customer, ie season cards, event tickets and products that can be redeemed at the kiosks.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products?clientName=VenueApp&clientOs=iPhone

URI Parameters

HideShow

clientName: string (required) Example: VenueApp
Used by the server to identify the App in use
clientOs: string (required) Example: iPhone
iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists.

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "products": [
    {
      "id": 12,
      "quantity": 3,
      "productName": "Tuborg",
      "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
      "siteId": 14,
      "siteName": "Ishockey"
    }
  ],
  "events": [
    {
      "id": 12,
      "name": "AGF",
      "eventUrl": "https://tickets.venuemanager.net",
      "eventStartTime": "2022-02-22T19:30:00+02:00",
      "eventImageUrl": "http://tickets.venuemanager.net/event/image.jpg",
      "eventVenue": "Jyske Bank Mors Arena",
      "organizerId": 1,
      "organizerName": "AGF",
      "tickets": [
        {
          "id": 42,
          "type": "80",
          "name": "Adult",
          "orderId": 1482,
          "borderColor": "#40e51f",
          "ticketExtraInfo": "Vi åbner senere end vi plejer",
          "stand": "``",
          "section": "B2",
          "row": 4,
          "seat": "2",
          "entrance": "13, 14",
          "validFromDate": "2019-04-01",
          "validToDate": "2019-10-31",
          "ticketEventStartTime": "2024-01-01T13:00:00+02:00",
          "status": "Used",
          "statusText": "Brugt",
          "statusTime": "2017-05-05T19:30:00+02:00",
          "qrcode": "abcdefghijklmnopqr",
          "addedProducts": [
            {
              "id": 42,
              "name": "Spisning",
              "quantity": 1
            }
          ],
          "dining": {
            "id": 42,
            "name": "Spisning",
            "loungeName": "Combine Lounge",
            "tableName": "Bord 1"
          }
        }
      ],
      "products": [
        {
          "id": 12,
          "quantity": 3,
          "productName": "Tuborg",
          "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
          "siteId": 14,
          "siteName": "Ishockey"
        }
      ]
    }
  ],
  "seasons": [
    {
      "id": 2,
      "name": "2017-2018",
      "organizerId": 1,
      "organizerName": "AGF",
      "seasoncards": [
        {
          "id": 42,
          "cardNumber": "43",
          "name": "VIP",
          "owner": {
            "name": "John Edward \"Jed\" York"
          },
          "seats": [
            {
              "hall": "Thy Hallen",
              "stand": "``",
              "section": "B2",
              "row": 4,
              "seat": "3",
              "entrance": [
                "A",
                "B"
              ]
            }
          ],
          "qrcode": "abcdefghijklmnopqr",
          "headerColor": "#ff0000",
          "backgroundImage": "http://placehold.it/350x150",
          "profileImage": "http://placehold.it/100x100",
          "profileImageCanBeChanged": false,
          "canBeLent": false,
          "maxViews": 2,
          "viewableBy": [
            {
              "id": 42,
              "name": "John Edward \"Jed\" York",
              "email": "john@example.com",
              "until": "2017-05-05T19:30:00+02:00"
            }
          ],
          "viewableFrom": {
            "id": 42,
            "name": "John Edward \"Jed\" York",
            "email": "john@example.com",
            "until": "2017-05-05T19:30:00+02:00"
          },
          "note": "Har altid adgang!",
          "attendancePercentage": 66.666,
          "attendanceEvents": [
            {
              "eventId": 12,
              "attended": true,
              "cardStatus": "added",
              "voucheredStatus": "Cancelled",
              "printedStatus": "Cancelled"
            }
          ]
        }
      ],
      "products": [
        {
          "id": 12,
          "quantity": 3,
          "productName": "Tuborg",
          "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
          "siteId": 14,
          "siteName": "Ishockey"
        }
      ]
    }
  ],
  "periodCards": [
    {
      "id": 84,
      "barcode": "8e40c018-601e-4381-b58c-50d5b13d6dd4",
      "periodStart": "2024-07-01",
      "periodEnd": "2025-06-30",
      "owner": {
        "name": "John Edward \"Jed\" York"
      },
      "cardTypeName": "Voksen",
      "headerColor": "#ff0000",
      "backgroundImageUrl": "http://placehold.it/350x150",
      "profileImageUrl": "http://placehold.it/100x100",
      "profileImageCanBeChanged": false,
      "isAutoRenewed": true,
      "canBeLent": false,
      "maxViews": 2,
      "viewableBy": [
        {
          "id": 42,
          "name": "John Edward \"Jed\" York",
          "email": "john@example.com",
          "until": "2017-05-05T19:30:00+02:00"
        }
      ],
      "viewableFrom": {
        "id": 42,
        "name": "John Edward \"Jed\" York",
        "email": "john@example.com",
        "until": "2017-05-05T19:30:00+02:00"
      },
      "renewalbleProducts": [
        {
          "id": 3,
          "name": "Årskort 2019",
          "label": "aarskort2019",
          "productType": "period_card",
          "priceInclVat": 685,
          "vat": 137,
          "currencyCode": "DKK",
          "appData": {
            "header": "Årskort",
            "description": "Årskort til hele året",
            "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
          }
        }
      ]
    }
  ],
  "vouchers": [
    {
      "id": 2,
      "header": "Louis Nielsen",
      "teaser": "Få tjecket dit syn",
      "description": "Gratis synstjek hos Loius Nielsen",
      "backgroundImage": "http://placehold.it/350x150",
      "expireDatetime": "2017-07-09T19:30:00+02:00",
      "codeIds": [
        500,
        501
      ]
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "products": {
      "type": "array",
      "description": "Products not bound to a specific event or season."
    },
    "events": {
      "type": "array",
      "description": "Tickets and products bound to specific events."
    },
    "seasons": {
      "type": "array",
      "description": "Season cards and products bound to specific seasons."
    },
    "periodCards": {
      "type": "array",
      "description": "Active period cards."
    },
    "vouchers": {
      "type": "array",
      "description": "Vouchers bound to the user."
    }
  }
}

Object: Products products ¶

Object: Products products
GET`/products/no-such-URL/Product`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/Product

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 12,
  "quantity": 3,
  "productName": "Tuborg",
  "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
  "siteId": 14,
  "siteName": "Ishockey"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "The product ID. Needed when redeeming the product."
    },
    "quantity": {
      "type": "number"
    },
    "productName": {
      "type": "string"
    },
    "backgroundImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "siteId": {
      "type": "number",
      "description": "Site ID"
    },
    "siteName": {
      "type": "string",
      "description": "Site name (often just \"-\")"
    }
  },
  "required": [
    "id",
    "quantity",
    "productName",
    "backgroundImage",
    "siteId",
    "siteName"
  ]
}

Object: Products events ¶

Object: Products events
GET`/products/no-such-URL/EventAndProducts`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/EventAndProducts

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 12,
  "name": "AGF",
  "eventUrl": "https://tickets.venuemanager.net",
  "eventStartTime": "2022-02-22T19:30:00+02:00",
  "eventImageUrl": "http://tickets.venuemanager.net/event/image.jpg",
  "eventVenue": "Jyske Bank Mors Arena",
  "organizerId": 1,
  "organizerName": "AGF",
  "tickets": [
    {
      "id": 42,
      "type": "80",
      "name": "Adult",
      "orderId": 1482,
      "borderColor": "#40e51f",
      "ticketExtraInfo": "Vi åbner senere end vi plejer",
      "stand": "``",
      "section": "B2",
      "row": 4,
      "seat": "2",
      "entrance": "13, 14",
      "validFromDate": "2019-04-01",
      "validToDate": "2019-10-31",
      "ticketEventStartTime": "2024-01-01T13:00:00+02:00",
      "status": "Used",
      "statusText": "Brugt",
      "statusTime": "2017-05-05T19:30:00+02:00",
      "qrcode": "abcdefghijklmnopqr",
      "addedProducts": [
        {
          "id": 42,
          "name": "Spisning",
          "quantity": 1
        }
      ],
      "dining": {
        "id": 42,
        "name": "Spisning",
        "loungeName": "Combine Lounge",
        "tableName": "Bord 1"
      }
    }
  ],
  "products": [
    {
      "id": 12,
      "quantity": 3,
      "productName": "Tuborg",
      "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
      "siteId": 14,
      "siteName": "Ishockey"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Event ID."
    },
    "name": {
      "type": "string",
      "description": "Vendsyssel FF (string, required) - Event name"
    },
    "eventUrl": {
      "type": "string",
      "description": "Event url"
    },
    "eventStartTime": {
      "type": "string",
      "description": "Event start time"
    },
    "eventImageUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "eventVenue": {
      "type": "string"
    },
    "organizerId": {
      "type": [
        "number",
        "null"
      ],
      "description": "Organizer ID"
    },
    "organizerName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Organizer name"
    },
    "tickets": {
      "type": "array",
      "description": "The customer's tickets for the event."
    },
    "products": {
      "type": "array",
      "description": "The customer's products bound to the event."
    }
  },
  "required": [
    "id",
    "eventStartTime",
    "eventVenue",
    "organizerId",
    "organizerName"
  ]
}

Object: Products events tickets ¶

Object: Products events tickets
GET`/products/no-such-URL/EventAndProducts/Ticket`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/EventAndProducts/Ticket

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 42,
  "type": "80",
  "name": "Adult",
  "orderId": 1482,
  "borderColor": "#40e51f",
  "ticketExtraInfo": "Vi åbner senere end vi plejer",
  "stand": "``",
  "section": "B2",
  "row": 4,
  "seat": "2",
  "entrance": "13, 14",
  "validFromDate": "2019-04-01",
  "validToDate": "2019-10-31",
  "ticketEventStartTime": "2024-01-01T13:00:00+02:00",
  "status": "Used",
  "statusText": "Brugt",
  "statusTime": "2017-05-05T19:30:00+02:00",
  "qrcode": "abcdefghijklmnopqr",
  "addedProducts": [
    {
      "id": 42,
      "name": "Spisning",
      "quantity": 1
    }
  ],
  "dining": {
    "id": 42,
    "name": "Spisning",
    "loungeName": "Combine Lounge",
    "tableName": "Bord 1"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "type": {
      "type": "string",
      "description": "Ticket type (can be a number)"
    },
    "name": {
      "type": "string",
      "description": "Ticket type name."
    },
    "orderId": {
      "type": "number",
      "description": "Ticket origin order id."
    },
    "borderColor": {
      "type": "string",
      "description": "Border color for easier visual ticket type recognition."
    },
    "ticketExtraInfo": {
      "type": "string",
      "description": "Extra info text for the ticket."
    },
    "stand": {
      "type": "string",
      "description": "Some venues name their stands."
    },
    "section": {
      "type": "string"
    },
    "row": {
      "type": "number"
    },
    "seat": {
      "type": "string"
    },
    "entrance": {
      "type": "string",
      "description": "The entrances that can be used to enter the venue with this ticket."
    },
    "validFromDate": {
      "type": "string",
      "description": "The ticket is valid from, and including, this date. If empty, it is valid for the duration of the event."
    },
    "validToDate": {
      "type": "string",
      "description": "The ticket is valid until, and including, this date. If empty, it is valid for the duration of the event."
    },
    "ticketEventStartTime": {
      "type": "string",
      "description": "Ticket specific event start time; often the same as event start time."
    },
    "status": {
      "type": "string",
      "description": "Current status of the ticket. If empty or \"Checked_out\" the ticket is valid. If \"Used\" or \"Cancelled\" it is not."
    },
    "statusText": {
      "type": "string",
      "description": "Translated status of the ticket. Is empty it the status is empty"
    },
    "statusTime": {
      "type": "string",
      "description": "Time when the status was last changed."
    },
    "qrcode": {
      "type": "string"
    },
    "addedProducts": {
      "type": "array"
    },
    "dining": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string",
          "description": "Name of the product"
        },
        "loungeName": {
          "type": "string",
          "description": "Name of the lounge, if placed"
        },
        "tableName": {
          "type": "string",
          "description": "Name of the table, if placed"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "required": [
    "id",
    "type",
    "name",
    "orderId",
    "ticketEventStartTime",
    "statusTime",
    "qrcode"
  ]
}

Object: Products seasons ¶

Object: Products seasons
GET`/products/no-such-URL/SeasonAndProducts`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/SeasonAndProducts

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 2,
  "name": "2017-2018",
  "organizerId": 1,
  "organizerName": "AGF",
  "seasoncards": [
    {
      "id": 42,
      "cardNumber": "43",
      "name": "VIP",
      "owner": {
        "name": "John Edward \"Jed\" York"
      },
      "seats": [
        {
          "hall": "Thy Hallen",
          "stand": "``",
          "section": "B2",
          "row": 4,
          "seat": "3",
          "entrance": [
            "A",
            "B"
          ]
        }
      ],
      "qrcode": "abcdefghijklmnopqr",
      "headerColor": "#ff0000",
      "backgroundImage": "http://placehold.it/350x150",
      "profileImage": "http://placehold.it/100x100",
      "profileImageCanBeChanged": false,
      "canBeLent": false,
      "maxViews": 2,
      "viewableBy": [
        {
          "id": 42,
          "name": "John Edward \"Jed\" York",
          "email": "john@example.com",
          "until": "2017-05-05T19:30:00+02:00"
        }
      ],
      "viewableFrom": {
        "id": 42,
        "name": "John Edward \"Jed\" York",
        "email": "john@example.com",
        "until": "2017-05-05T19:30:00+02:00"
      },
      "note": "Har altid adgang!",
      "attendancePercentage": 66.666,
      "attendanceEvents": [
        {
          "eventId": 12,
          "attended": true,
          "cardStatus": "added",
          "voucheredStatus": "Cancelled",
          "printedStatus": "Cancelled"
        }
      ]
    }
  ],
  "products": [
    {
      "id": 12,
      "quantity": 3,
      "productName": "Tuborg",
      "backgroundImage": "https://lejfesttelt.dk/images/products_thumb/1440509131_plastikrus.png",
      "siteId": 14,
      "siteName": "Ishockey"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Season ID."
    },
    "name": {
      "type": "string",
      "description": "Name of season."
    },
    "organizerId": {
      "type": [
        "number",
        "null"
      ],
      "description": "Organizer ID"
    },
    "organizerName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Organizer name"
    },
    "seasoncards": {
      "type": "array",
      "description": "The customer's season cards for the season."
    },
    "products": {
      "type": "array",
      "description": "The customer's products bound to the season."
    }
  },
  "required": [
    "id",
    "name",
    "organizerId",
    "organizerName"
  ]
}

Object: Products seasons seasoncards ¶

Object: Products seasons seasoncards
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/SeasonAndProducts/SeasonCard

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 42,
  "cardNumber": "43",
  "name": "VIP",
  "owner": {
    "name": "John Edward \"Jed\" York"
  },
  "seats": [
    {
      "hall": "Thy Hallen",
      "stand": "``",
      "section": "B2",
      "row": 4,
      "seat": "3",
      "entrance": [
        "A",
        "B"
      ]
    }
  ],
  "qrcode": "abcdefghijklmnopqr",
  "headerColor": "#ff0000",
  "backgroundImage": "http://placehold.it/350x150",
  "profileImage": "http://placehold.it/100x100",
  "profileImageCanBeChanged": false,
  "canBeLent": false,
  "maxViews": 2,
  "viewableBy": [
    {
      "id": 42,
      "name": "John Edward \"Jed\" York",
      "email": "john@example.com",
      "until": "2017-05-05T19:30:00+02:00"
    }
  ],
  "viewableFrom": {
    "id": 42,
    "name": "John Edward \"Jed\" York",
    "email": "john@example.com",
    "until": "2017-05-05T19:30:00+02:00"
  },
  "note": "Har altid adgang!",
  "attendancePercentage": 66.666,
  "attendanceEvents": [
    {
      "eventId": 12,
      "attended": true,
      "cardStatus": "added",
      "voucheredStatus": "Cancelled",
      "printedStatus": "Cancelled"
    }
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "cardNumber": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Card type"
    },
    "owner": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ]
    },
    "seats": {
      "type": "array"
    },
    "qrcode": {
      "type": "string"
    },
    "headerColor": {
      "type": "string"
    },
    "backgroundImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "profileImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "profileImageCanBeChanged": {
      "type": "boolean"
    },
    "canBeLent": {
      "type": "boolean",
      "description": "- Whether or not this season card can be lent to another customer"
    },
    "maxViews": {
      "type": "number",
      "description": "- How many other customers can view this season card. Includes those who are already viewing it (viewableBy). If this is 1, a borrowed card cannot be used by the owner, until it is retracted."
    },
    "viewableBy": {
      "type": "array",
      "description": "- The season card is being viewed, and thereby usable, by these customers"
    },
    "viewableFrom": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number"
        },
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "until": {
          "type": "string",
          "description": "The time when the card is automatically no longer borrowed or viewed (can be null)"
        }
      },
      "required": [
        "id",
        "name",
        "email"
      ],
      "description": "- The season card is not the customer's own, and is currently being viewed from this customer"
    },
    "note": {
      "type": "string",
      "description": "Printable note"
    },
    "attendancePercentage": {
      "type": "number",
      "description": "The percentage of attendance for the past events"
    },
    "attendanceEvents": {
      "type": "array",
      "description": "Attendance details for each past event"
    }
  },
  "required": [
    "id",
    "cardNumber",
    "name",
    "qrcode"
  ]
}

Object: Products seasons seasoncards viewableBy ¶

Object: Products seasons seasoncards viewableBy
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardCustomer`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardCustomer

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 42,
  "name": "John Edward \"Jed\" York",
  "email": "john@example.com",
  "until": "2017-05-05T19:30:00+02:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "until": {
      "type": "string",
      "description": "The time when the card is automatically no longer borrowed or viewed (can be null)"
    }
  },
  "required": [
    "id",
    "name",
    "email"
  ]
}

Object: Products seasons seasoncards attendanceEvents ¶

Object: Products seasons seasoncards attendanceEvents
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardAttendanceEvent`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardAttendanceEvent

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "eventId": 12,
  "attended": true,
  "cardStatus": "added",
  "voucheredStatus": "Cancelled",
  "printedStatus": "Cancelled"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "eventId": {
      "type": "number"
    },
    "attended": {
      "type": "boolean",
      "description": "Whether or not the season card attended this event in any form"
    },
    "cardStatus": {
      "type": "string",
      "enum": [
        "added",
        "cancelled",
        "checked_out",
        "printed",
        "reserved",
        "used",
        "vouchered"
      ],
      "description": "Status of the card it self"
    },
    "voucheredStatus": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Cancelled",
        "Checked_out",
        "Used",
        null
      ],
      "description": "Status of the ticket if the card is vouchered"
    },
    "printedStatus": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "Cancelled",
        "Checked_out",
        "Used",
        null
      ],
      "description": "Status of the ticket if the card is printed"
    }
  },
  "required": [
    "eventId",
    "attended",
    "cardStatus",
    "voucheredStatus",
    "printedStatus"
  ]
}

Object: Products vouchers ¶

Object: Products vouchers
GET`/products/no-such-URL/VoucherWithCodes`

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/products/no-such-URL/VoucherWithCodes

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 2,
  "header": "Louis Nielsen",
  "teaser": "Få tjecket dit syn",
  "description": "Gratis synstjek hos Loius Nielsen",
  "backgroundImage": "http://placehold.it/350x150",
  "expireDatetime": "2017-07-09T19:30:00+02:00",
  "codeIds": [
    500,
    501
  ]
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Voucher series ID."
    },
    "header": {
      "type": "string",
      "description": "Header."
    },
    "teaser": {
      "type": "string",
      "description": "Teaser."
    },
    "description": {
      "type": "string"
    },
    "backgroundImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "expireDatetime": {
      "type": "string"
    },
    "codeIds": {
      "type": "array",
      "description": "Voucher code ID."
    }
  },
  "required": [
    "id",
    "header",
    "teaser",
    "description",
    "backgroundImage",
    "expireDatetime",
    "codeIds"
  ]
}

Vouchers ¶

Get vouchers
GET`/vouchers`

Used for retrieving a list of all available vouchers.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/vouchers

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 2,
    "header": "Louis Nielsen",
    "teaser": "Få tjecket dit syn",
    "description": "Gratis synstjek hos Loius Nielsen",
    "backgroundImage": "http://placehold.it/350x150",
    "expireDatetime": "2017-07-09T19:30:00+02:00"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Get/claim voucher ¶

Get voucher info
GET`/vouchers/voucher/{id}?clientName={clientName}&clientOs={clientOs}`

This endpoint is used for getting details of a voucher series.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/vouchers/voucher/2?clientName=VenueApp&clientOs=iPhone

URI Parameters

HideShow

id: number (required) Example: 2
clientName: string (required) Example: VenueApp
Used by the server to identify the App in use
clientOs: string (required) Example: iPhone
iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists.

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 2,
  "header": "Louis Nielsen",
  "teaser": "Få tjecket dit syn",
  "description": "Gratis synstjek hos Loius Nielsen",
  "backgroundImage": "http://placehold.it/350x150",
  "expireDatetime": "2017-07-09T19:30:00+02:00"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Voucher series ID."
    },
    "header": {
      "type": "string",
      "description": "Header."
    },
    "teaser": {
      "type": "string",
      "description": "Teaser."
    },
    "description": {
      "type": "string"
    },
    "backgroundImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "expireDatetime": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "header",
    "teaser",
    "description",
    "backgroundImage",
    "expireDatetime"
  ]
}

Claim voucher
POST`/vouchers/voucher/?clientName=&clientOs=`

This endpoint is used for claiming a voucher. Creates a voucher code and associate it to the customer

Example URI

POST https://{customer}.admin.venuemanager.net/api/venueapp/vouchers/voucher/?clientName=&clientOs=

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Response 200

HideShow

This is the expected response - the voucher were claimed without errors. The created voucher code is returned.

Body

{
  "id": 2,
  "header": "Louis Nielsen",
  "teaser": "Få tjecket dit syn",
  "description": "Gratis synstjek hos Loius Nielsen",
  "backgroundImage": "http://placehold.it/350x150",
  "expireDatetime": "2017-07-09T19:30:00+02:00",
  "codeIds": [
    500,
    501
  ]
}

Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Voucher series ID."
    },
    "header": {
      "type": "string",
      "description": "Header."
    },
    "teaser": {
      "type": "string",
      "description": "Teaser."
    },
    "description": {
      "type": "string"
    },
    "backgroundImage": {
      "type": [
        "string",
        "null"
      ]
    },
    "expireDatetime": {
      "type": "string"
    },
    "codeIds": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Voucher code ID."
    }
  },
  "required": [
    "id",
    "header",
    "teaser",
    "description",
    "backgroundImage",
    "expireDatetime",
    "codeIds"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 400

HideShow

The voucher could not be claimed. E.g. The voucher has already been claimed.

Headers

Content-Type: application/json

Body

{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Redeem voucher
POST`/vouchers/vouchercode/{codeId}`

This endpoint is used when a customer wants to redeem a voucher.

Example URI

POST https://{customer}.admin.venuemanager.net/api/venueapp/vouchers/vouchercode/500

URI Parameters

HideShow

codeId: number (required) Example: 500
ID of the voucher to redeem

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Body

{
  "clientName": "VenueApp",
  "clientOs": "iPhone"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "clientName": {
      "type": "string",
      "description": "Used by the server to identify the App in use"
    },
    "clientOs": {
      "type": "string",
      "description": "iOS - 12.0 (string, required) - Stored serverside to make it easier for the customer to distinguish his tokens in lists."
    }
  },
  "required": [
    "clientName"
  ]
}

Response 204

HideShow

This is the expected response - the vouchers were redeemed without errors. No content is returned.

Response 400

HideShow

The voucher could not be redeemed.

Headers

Content-Type: application/json

Body

{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Messages ¶

Messages
GET`/messages?from={fromDate}&to={toDate}`

Returns the push messages that has been sent to the customer, ordered by sent time.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/messages?from=fromDate&to=toDate

URI Parameters

HideShow

fromDate: string (required)
Messages after this date
toDate: string (required)
Messages before this date

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 1,
    "title": "Orci varius natoque penatibus",
    "body": "Praesent eget est tempor, volutpat magna bibendum, cursus diam. Vivamus a erat nec lectus egestas rhoncus. Morbi consectetur felis vel pellentesque rutrum.",
    "sentTime": "2017-08-02 12:34:56"
  },
  {
    "id": 2,
    "title": "Nulla rhoncus sed",
    "body": "Curabitur quis dolor nec purus euismod ullamcorper. Suspendisse ac bibendum dolor. Mauris urna massa, varius a felis ut, consectetur facilisis quam.",
    "sentTime": "2017-08-04 23:45:01"
  }
]

Images ¶

Upload ¶

Upload
POST`/image`

Upload an image for usage on season card. In the response, an expiration date is supplied for last order time this image can still be expected to exist.

Example URI

POST https://{customer}.admin.venuemanager.net/api/venueapp/image

Request

HideShow

Headers

Content-Type: multipart/form-data; boundary=BOUNDARY
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w

Body

--BOUNDARY
Content-Disposition: form-data; name="image"; filename="image.jpg"
Content-Type: image/jpeg
Content-Transfer-Encoding: base64

/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0a
HBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIy
MjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAABAAEDASIA
AhEBAxEB/8QAFQABAQAAAAAAAAAAAAAAAAAAAAf/xAAUEAEAAAAAAAAAAAAAAAAAAAAA/8QAFAEB
AAAAAAAAAAAAAAAAAAAAAP/EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AL+AD//Z
--BOUNDARY
Content-Disposition: form-data; name="json"

{
    "module": "season",
    "tags": [
        "profile"
    ]
}
--BOUNDARY--

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "id": 3528,
  "expirationDate": "2019-02-19 14:44"
}

Fårup Sommerland ¶

Fårup Sommerland-specific functionality.

Queues ¶

Queues
GET`/queue`

Retrieve a list of all available queues.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/queue

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 4,
    "name": "4D Biografen"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Waiting time ¶

Waiting time
GET`/queue/{queueId}/waitingTime?languageCode={languageCode}`

Return the waiting-time in the specific queue.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/queue/4/waitingTime?languageCode=da

URI Parameters

HideShow

queueId: number (required) Example: 4
The queue to get waiting time for
languageCode: string (required) Example: da
The language the waiting time should be translated as. If missing, or unknown to the shop, the default language will be used

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w

Response 200

HideShow

Headers

Content-Type: application/json

Body

{
  "waitingtime": "0-10 minutters ventetid",
  "queueStatusCode": 8,
  "lastUpdate": "2019-05-05 09:22:44"
}

Period card ¶

Functionality for period cards.

Update ¶

Update
POST`/periodCard/{periodCardId}`

Updates a period card

Example URI

POST https://{customer}.admin.venuemanager.net/api/venueapp/periodCard/30

URI Parameters

HideShow

periodCardId: number (required) Example: 30

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Body

{
  "profileImageId": 123
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "profileImageId": {
      "type": "number",
      "description": "Id of the new profile image"
    }
  }
}

Response 204

HideShow

This is the expected response - the period card is updated without errors. No content is returned.

Response 400

HideShow

The period card could not be updated.

Headers

Content-Type: application/json

Body

{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

Renewable period cards ¶

Renewable period cards
GET`/periodCard/renewableCards`

Returns the period cards that can be renewed and the products they can be renewed to.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/periodCard/renewableCards

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 84,
    "barcode": "8e40c018-601e-4381-b58c-50d5b13d6dd4",
    "periodStart": "2024-07-01",
    "periodEnd": "2025-06-30",
    "owner": {
      "name": "John Edward \"Jed\" York"
    },
    "cardTypeName": "Voksen",
    "headerColor": "#ff0000",
    "backgroundImageUrl": "http://placehold.it/350x150",
    "profileImageUrl": "http://placehold.it/100x100",
    "profileImageCanBeChanged": false,
    "isAutoRenewed": true,
    "canBeLent": false,
    "maxViews": 2,
    "viewableBy": [
      {
        "id": 42,
        "name": "John Edward \"Jed\" York",
        "email": "john@example.com",
        "until": "2017-05-05T19:30:00+02:00"
      }
    ],
    "viewableFrom": {
      "id": 42,
      "name": "John Edward \"Jed\" York",
      "email": "john@example.com",
      "until": "2017-05-05T19:30:00+02:00"
    },
    "renewalbleProducts": [
      {
        "id": 3,
        "name": "Årskort 2019",
        "label": "aarskort2019",
        "productType": "period_card",
        "priceInclVat": 685,
        "vat": 137,
        "currencyCode": "DKK",
        "appData": {
          "header": "Årskort",
          "description": "Årskort til hele året",
          "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
        }
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Lend ¶

Lend
PUT`/periodCard/{periodCardId}/lend`

Lend a period card to customer with emailAddress

Example URI

PUT https://{customer}.admin.venuemanager.net/api/venueapp/periodCard/30/lend

URI Parameters

HideShow

periodCardId: number (required) Example: 30

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Body

{
  "emailAddress": "dev_shop@venuemanager.net",
  "until": "2019"
}

Schema

{
  "type": "object",
  "properties": {
    "emailAddress": {
      "type": "string"
    },
    "until": {
      "type": "string",
      "description": "09-19 19:09:19 (string, optional)"
    }
  },
  "required": [
    "emailAddress"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 204

HideShow

This is the expected response

Headers

Content-Type: application/json

Response 400

HideShow

The period card cannot be lent out

Headers

Content-Type: application/json

Response 401

HideShow

The requesting customer does not own this card

Headers

Content-Type: application/json

Response 404

HideShow

Target customer not found by email address

Headers

Content-Type: application/json

Cancel lend ¶

Cancel lend
DELETE`/periodCard/{periodCardId}/lend/{customerId}`

Take back lend.

Example URI

DELETE https://{customer}.admin.venuemanager.net/api/venueapp/periodCard/30/lend/3421

URI Parameters

HideShow

periodCardId: number (required) Example: 30
customerId: number (required) Example: 3421

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Response 204

HideShow

This is the expected response

Headers

Content-Type: application/json

Response 401

HideShow

The requesting customer does not own this card

Headers

Content-Type: application/json

Response 404

HideShow

Target customer does not currently lend this card

Headers

Content-Type: application/json

Season card ¶

Functionality for season cards

Update ¶

Update
POST`/seasonCard/{seasonCardId}`

Updates a season card

Example URI

POST https://{customer}.admin.venuemanager.net/api/venueapp/seasonCard/20

URI Parameters

HideShow

seasonCardId: number (required) Example: 20

Request

HideShow

Headers

Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Body

{
  "profileImageId": 123
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "profileImageId": {
      "type": "number",
      "description": "Id of the new profile image"
    }
  }
}

Response 204

HideShow

This is the expected response - the season card is updated without errors. No content is returned.

Response 400

HideShow

The season card could not be updated.

Headers

Content-Type: application/json

Body

{
  "error": "Winston writes in his forbidden diary.",
  "errorCode": 1984
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Textual description of the error."
    },
    "errorCode": {
      "type": "number",
      "description": "A code, often 0."
    }
  },
  "required": [
    "error"
  ]
}

RenewableSeasonCards ¶

RenewableSeasonCards
GET`/seasonCard/renewableCards`

Returns the seasoncards that can be renewed and the products they can be renewed to.

Example URI

GET https://{customer}.admin.venuemanager.net/api/venueapp/seasonCard/renewableCards

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Response 200

HideShow

Headers

Content-Type: application/json

Body

[
  {
    "id": 2,
    "name": "2017-2018",
    "seasoncards": [
      {
        "id": 42,
        "cardNumber": "43",
        "name": "VIP",
        "owner": {
          "name": "John Edward \"Jed\" York"
        },
        "seats": [
          {
            "hall": "Thy Hallen",
            "stand": "``",
            "section": "B2",
            "row": 4,
            "seat": "3",
            "entrance": [
              "A",
              "B"
            ]
          }
        ],
        "qrcode": "abcdefghijklmnopqr",
        "headerColor": "#ff0000",
        "backgroundImage": "http://placehold.it/350x150",
        "profileImage": "http://placehold.it/100x100",
        "profileImageCanBeChanged": false,
        "canBeLent": false,
        "maxViews": 2,
        "viewableBy": [
          {
            "id": 42,
            "name": "John Edward \"Jed\" York",
            "email": "john@example.com",
            "until": "2017-05-05T19:30:00+02:00"
          }
        ],
        "viewableFrom": {
          "id": 42,
          "name": "John Edward \"Jed\" York",
          "email": "john@example.com",
          "until": "2017-05-05T19:30:00+02:00"
        },
        "note": "Har altid adgang!",
        "attendancePercentage": 66.666,
        "attendanceEvents": [
          {
            "eventId": 12,
            "attended": true,
            "cardStatus": "added",
            "voucheredStatus": "Cancelled",
            "printedStatus": "Cancelled"
          }
        ],
        "products": [
          {
            "id": 3,
            "name": "Årskort 2019",
            "label": "aarskort2019",
            "productType": "seasoncard",
            "priceInclVat": 685,
            "vat": 137,
            "currencyCode": "DKK",
            "appData": {
              "header": "Årskort",
              "description": "Årskort til hele året",
              "image": "https://image.experimentarium.dk/media/catalog/product/cache/1/image/9df78eab33525d08d6e5fb8d27136e95/api/%C3%85rskort%20Senior.png"
            },
            "properties": {
              "seasonCardIsBuyable": "1",
              "seasonCardIsRenewable": "0"
            }
          }
        ]
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array"
}

Lend ¶

Lend
PUT`/seasonCard/{seasonCardId}/lend`

Lend a season card to customer with emailAddress

Example URI

PUT https://{customer}.admin.venuemanager.net/api/venueapp/seasonCard/20/lend

URI Parameters

HideShow

seasonCardId: number (required) Example: 20

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Body

{
  "emailAddress": "dev_shop@combine.dk",
  "until": "2019"
}

Schema

{
  "type": "object",
  "properties": {
    "emailAddress": {
      "type": "string"
    },
    "until": {
      "type": "string",
      "description": "09-19 19:09:19 (string, optional)"
    }
  },
  "required": [
    "emailAddress"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Response 204

HideShow

This is the expected response

Headers

Content-Type: application/json

Response 400

HideShow

The season card cannot be lent out

Headers

Content-Type: application/json

Response 401

HideShow

The requesting customer does not own this card

Headers

Content-Type: application/json

Response 404

HideShow

Target customer not found by email address

Headers

Content-Type: application/json

Cancel lend ¶

Cancel lend
DELETE`/seasonCard/{seasonCardId}/lend/{customerId}`

Take back lend.

Example URI

DELETE https://{customer}.admin.venuemanager.net/api/venueapp/seasonCard/20/lend/3421

URI Parameters

HideShow

seasonCardId: number (required) Example: 20
customerId: number (required) Example: 3421

Request

HideShow

Headers

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJkZXZlbG9wbWVudF9hZ2YiLCJpYXQiOjE0ODkwNzIyNjAsImp0aSI6Nn0.z-9FNz-3twoxqy_E06Q1ryQO_VHHxK5710Fe9ILH-5w
Accept: application/json

Response 204

HideShow

This is the expected response

Headers

Content-Type: application/json

Response 401

HideShow

The requesting customer does not own this card

Headers

Content-Type: application/json

Home screen ¶

Home ¶

HomeGET/home

Example URI

Headers

Headers

Body

Schema

Events ¶

Events ¶

EventsGET/events

Example URI

Headers

Body

Schema

Customer Products ¶

Products ¶

ProductsGET/products?clientName={clientName}&clientOs={clientOs}

Example URI

Headers

Headers

Body

Schema

Object: Products products ¶

Object: Products productsGET/products/no-such-URL/Product

Example URI

Headers

Body

Schema

Object: Products events ¶

Object: Products eventsGET/products/no-such-URL/EventAndProducts

Example URI

Headers

Body

Schema

Object: Products events tickets ¶

Object: Products events ticketsGET/products/no-such-URL/EventAndProducts/Ticket

Example URI

Headers

Body

Schema

Object: Products seasons ¶

Object: Products seasonsGET/products/no-such-URL/SeasonAndProducts

Example URI

Headers

Body

Schema

Object: Products seasons seasoncards ¶

Object: Products seasons seasoncardsGET/products/no-such-URL/SeasonAndProducts/SeasonCard

Example URI

Headers

Body

Schema

Object: Products seasons seasoncards viewableBy ¶

Object: Products seasons seasoncards viewableByGET/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardCustomer

Example URI

Headers

Body

Schema

Object: Products seasons seasoncards attendanceEvents ¶

Object: Products seasons seasoncards attendanceEventsGET/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardAttendanceEvent

Example URI

Headers

Body

Schema

Object: Products vouchers ¶

Object: Products vouchersGET/products/no-such-URL/VoucherWithCodes

Example URI

Headers

Body

Schema

Vouchers ¶

Vouchers ¶

Get vouchersGET/vouchers

Example URI

Headers

Body

Schema

Get/claim voucher ¶

Get voucher infoGET/vouchers/voucher/{id}?clientName={clientName}&clientOs={clientOs}

Home
GET`/home`

Events
GET`/events`

Products
GET`/products?clientName={clientName}&clientOs={clientOs}`

Object: Products products
GET`/products/no-such-URL/Product`

Object: Products events
GET`/products/no-such-URL/EventAndProducts`

Object: Products events tickets
GET`/products/no-such-URL/EventAndProducts/Ticket`

Object: Products seasons
GET`/products/no-such-URL/SeasonAndProducts`

Object: Products seasons seasoncards
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard`

Object: Products seasons seasoncards viewableBy
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardCustomer`

Object: Products seasons seasoncards attendanceEvents
GET`/products/no-such-URL/SeasonAndProducts/SeasonCard/SeasonCardAttendanceEvent`

Object: Products vouchers
GET`/products/no-such-URL/VoucherWithCodes`

Get vouchers
GET`/vouchers`

Get voucher info
GET`/vouchers/voucher/{id}?clientName={clientName}&clientOs={clientOs}`

Claim voucher
POST`/vouchers/voucher/?clientName=&clientOs=`

Redeem voucher
POST`/vouchers/vouchercode/{codeId}`

Messages
GET`/messages?from={fromDate}&to={toDate}`

Upload
POST`/image`

Queues
GET`/queue`

Waiting time
GET`/queue/{queueId}/waitingTime?languageCode={languageCode}`

Update
POST`/periodCard/{periodCardId}`

Renewable period cards
GET`/periodCard/renewableCards`

Lend
PUT`/periodCard/{periodCardId}/lend`