API docs by Redocly

Notification API (1.0.0)

Download OpenAPI specification:

Amusement Connect: api@amusementconnect.com URL: https://amusementconnect.com/ License: MIT

API for using Amusement Connect notifications

HappyHour

Happy Hour

Get Happy Hours

Retrieve a list of happy hours.

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

required
integer or string

The unique identifier of the location.

take
integer
Example: take=10

The maximum number of records to return in the response. If not specified, all records are returned.

skip
integer
Example: skip=10

The number of records to skip in the response. If not specified, no records are skipped.

upcomingOccurrences
integer
Default: 0

How many of the next upcoming occurrences of each schedule to include.

status
string
Enum: "Active" "Pending" "Completed"

Filter happy hours by status.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalCount": 0
}

Create Happy Hour

Create a new happy hour.

Authorizations:
apiKey
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required
required
integer or string
startDate
required
string <date>
endDate
string or null <date>
startTime
required
string <time>
endTime
required
string <time>
daysOfWeek
required
Array of any (DaysOfWeek)
Items Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
gameCategories
Array of strings[ items non-empty ]
creditMultiplier
required
number >= 0
Default: 1
ticketMultiplier
required
number >= 0
Default: 1
userOffsetMinutes
integer or null [ -720 .. 840 ]

Responses

Request samples

Content type
application/json
{
  • "locationId": 0,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "startTime": "14:15:22Z",
  • "endTime": "14:15:22Z",
  • "daysOfWeek": [
    ],
  • "gameCategories": [
    ],
  • "creditMultiplier": 1,
  • "ticketMultiplier": 1,
  • "userOffsetMinutes": -720
}

Response samples

Content type
application/json
{
  • "schedule": {
    },
  • "occurrences": [
    ]
}

Get Happy Hour by ID

Retrieve a happy hour by its unique identifier.

Authorizations:
apiKey
path Parameters
happyHourScheduleId
required
integer

The unique identifier of the happy hour schedule.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

upcomingOccurrences
integer
Default: 0

How many of the next upcoming occurrences of each schedule to include.

Responses

Response samples

Content type
application/json
{
  • "schedule": {
    },
  • "occurrences": [
    ]
}

Update Happy Hour

Update an existing happy hour.

Authorizations:
apiKey
path Parameters
happyHourScheduleId
required
integer

The unique identifier of the happy hour schedule.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Request Body schema: application/json
required
daysOfWeek
Array of any or null (DaysOfWeek)
Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
startDate
string <date>
endDate
string or null <date>
startTime
string or null <time>
endTime
string or null <time>
gameCategories
Array of strings or null
creditMultiplier
number or null
ticketMultiplier
number or null
userOffsetMinutes
integer or null [ -720 .. 840 ]

Responses

Request samples

Content type
application/json
{
  • "daysOfWeek": [
    ],
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "startTime": "14:15:22Z",
  • "endTime": "14:15:22Z",
  • "gameCategories": [
    ],
  • "creditMultiplier": 0,
  • "ticketMultiplier": 0,
  • "userOffsetMinutes": -720
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    }
}

Delete Happy Hour

Delete a happy hour by its unique identifier.

Authorizations:
apiKey
path Parameters
happyHourScheduleId
required
integer

The unique identifier of the happy hour schedule.

query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The version of the API to use.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "errors": {
    }
}