API docs by Redocly

Device Service (1.0.1)

Download OpenAPI specification:

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

API for Amusement Connect devices

Commissioning

Commissioning of Amusement Connect devices

Commissions a new Amusement Connect device for future registration.

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

The requested API version

Request Body schema:
macId
required
string non-empty
deviceType
required
string (DeviceType)
Enum: "Reader" "MobileMech"
hardwareVersion
required
string (DeviceGenVersion)
Enum: "Gen3" "Gen4" "Mmg1"
makerMark
required
string (MakerName)
Enum: "PivotAvatar" "GTGChina" "EMSAR" "DMW_China"

Responses

Request samples

Content type
{
  • "macId": "string",
  • "deviceType": "Reader",
  • "hardwareVersion": "Gen3",
  • "makerMark": "PivotAvatar"
}

Response samples

Content type
No sample

Device

Device operations for Amusement Connect devices

Gets the configuration for a device

Authorizations:
apiKey
path Parameters
deviceId
required
string

ID of the device

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

The requested API version

Responses

Response samples

Content type
application/json
Example
{
  • "apiUrl": "string",
  • "updatePackageVersion": "string",
  • "updatePackageDownloadPath": "string",
  • "iotConnectionString": "string",
  • "operationMode": "Normal",
  • "macId": "string",
  • "readerType": 0,
  • "configTicketMultiplier": 0.1,
  • "freeplayTicketMultiplier": 0.1,
  • "coinPulses": 0,
  • "coinPulseLength": 0,
  • "coinPulseDelay": 0,
  • "ticketLength": 0,
  • "notchLength": 0,
  • "switchType": true,
  • "ticketMechTypeAsHigh": true,
  • "ticketMechThresholdVoltage": 0.1,
  • "noOfDecimalsOnLCD": 0,
  • "flipDisplay": true,
  • "portrait": true,
  • "ticketPostingDelay": 0,
  • "maxTickets": 0,
  • "mercyTickets": 0.1,
  • "pricingUnits": "string",
  • "ticketFieldName": "string",
  • "addTickets": 0,
  • "awardTicket": true,
  • "generalThemeId": "string",
  • "happyHourThemeId": "string",
  • "specialThemeId": "string",
  • "themeDownloadPath": "string",
  • "volumeLevel": 0,
  • "qrData": "string",
  • "setBacklight": 0,
  • "readerName": "string",
  • "creditRequired": 0.1,
  • "ssid": "string",
  • "password": "string",
  • "happyHourTicketMultiplier": 0.1,
  • "happyHourActive": true,
  • "activeThemeId": "string",
  • "managerCards": [
    ],
  • "readerAction": 0
}

Refreshes the device's device twin to apply any new configuration

Authorizations:
apiKey
path Parameters
deviceId
required
string

ID of the device

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

The requested API version

Responses

Response samples

Content type
Example
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Migrates a device to the new IoT Hub

This endpoint updates the device's IotHub connection string to point to a new IotHub. The devices current device-twin will get the new connection string and reconnect to the new IotHub

Authorizations:
apiKey
path Parameters
deviceId
required
string

ID of the device

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

The requested API version

Request Body schema: application/json
iotHubConnectionString
string

The connection string for the IoT Hub the device is migrating to

Responses

Request samples

Content type
application/json
{
  • "iotHubConnectionString": "string"
}

Response samples

Content type
Example
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Gets the history of events for a device

Authorizations:
apiKey
path Parameters
deviceId
required
string

ID of the device

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

The requested API version

top
integer
Example: top=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.

Responses

Response samples

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

Registration

Registration for Amusement Connect devices

Validates that a device can be registered with the given pin code

Authorizations:
apiKey
path Parameters
deviceId
required
string
query Parameters
apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Request Body schema:
pin
string

Responses

Request samples

Content type
{
  • "pin": "string"
}

Response samples

Content type
application/json
{
  • "canRegister": true
}

Registers a new Amusement Connect device with an organization Registers a new Amusement Connect device with an organization

Authorizations:
apiKey
path Parameters
deviceId
required
string

The id of the device

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

The requested API version

Request Body schema:

The request body

pin
string
organizationId
string <uuid>
locationId
integer <int32>
userId
string <uuid>

Responses

Request samples

Content type
{
  • "pin": "string",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "locationId": 0,
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
Example
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Unregisters a device, removing it from the organization so it can be registered elsewhere.

Authorizations:
apiKey
path Parameters
deviceId
required
string

The id of the device

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

The requested API version

Request Body schema: application/json
userId
string

Optional, ID of the user performing the unregistration

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
Example
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Lists unregistered devices

Authorizations:
apiKey
query Parameters
top
integer
Example: top=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.

search
string

A search term to filter devices by name or ID. If not specified, all unregistered devices are returned.

deviceType
string
Enum: "Reader" "MobileMech"

Filter by device type. If not specified, devices of all types are returned.

apiVersion
string
Default: "1.0"
Value: "1.0"

The requested API version

Responses

Response samples

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