/
CE
centeredge
/
Advantage API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 10h ago · Updated 3w ago
Details
Filter operations
Activities
2
get
/api/v1/activities
get
/api/v1/activities/{id}/starttimes
Auth
1
post
/api/v1/auth/token
Authentication
2
post
Posts a request to log in to the Phoenix system
get
Tests Phoenix authentication
BulkWaiverImport
1
post
Create a waiver.
BusinessEntity
1
get
Get Phoenix BusinessEntity
CardLayout
1
get
Get a list of Card Layouts.
CatalogEntries
2
get
Get a list of catalog entries.
get
Get a single catalog entry by Id.
Categories
2
get
Get a list of categories.
get
Get a single category by Id.
CustomerCards
1
get
Get a single customer by their customer card number.
Customers
4
get
Get a list of customers.
post
Create a customer.
get
Get a single customer by ID.
put
Perform a customer merge operation
CustomerWaivers
1
get
Get a list of waivers for a specific customer.
Divisions
2
get
Get a single division by Id.
get
Get a list of divisions.
Fingerprints
1
post
Gets the employee number by fingerprint.
GroupEvents
2
post
/api/v1/groupevents/{id}/notify
get
Get a single group event by id.
Jobs
1
get
Check the status of a phoenix job
Media
1
post
Parse raw media data and return media info.
MediaBalance
1
get
Parse raw media data and return media info.
MediaPlayPrivilege
1
get
Parse raw media data and return media info.
MediaTimePlay
1
get
Get the list of time plays on a piece of media.
ModifierSets
2
get
Get a list of modifier sets.
get
Get a single modifier set by Id.
Passes
3
post
Creates a single pass
get
Returns a single pass
patch
Updates a single pass
PassType
2
get
Get a single pass type by id.
get
Get a list of pass types.
PassUseOptions
1
post
Validates which items may be used by a customer's passes
PassUses
1
get
Returns the list of uses for a single pass
PayrollExport
1
get
Returns a stream of the payroll export in the specified format between the given dates
Price
1
get
Get a list of catalog entries.
PriceLists
1
get
Get all the entries with prices
Products
3
get
Get a list of products.
get
Get a single product by Id.
get
Get a list of product SKUs by product id.
Refresh
1
get
/api/v1/configuration/refresh
Reservations
4
post
/api/v1/activities/{activityId}/reservations
put
/api/v1/activities/{activityId}/unpaidreservations/{id}
get
/api/v1/unpaidreservations/{id}
delete
/api/v1/unpaidreservations/{id}
SalesTax
1
post
Calculate sales tax for a transaction.
Station
1
post
Creates an Advantage station as described and using the provided short-term authentication
TicketFormats
2
get
Get a Advantage.TicketFormats.Models.TicketFormat by id and type
get
Get a list of Advantage.TicketFormats.Models.TicketFormats
Tills
1
get
Get a single till by Id.
Transactions
4
get
Get a single transaction by ID.
put
Update a transaction.
post
Create a transaction.
post
/api/v1/transactions/{transactionId}/notify
Updates
9
get
Get patches
get
Get update file info
get
Get unapplied patches
get
Get file
get
Get update file
get
Checks the latest version available
post
Applies latest Update
post
Applies staging files
post
Updates station applied patch info
UrlToPay
6
get
Gets the list of UrlToPay objects from the local Advantage database. This data may not be 100% consistent with what is in phoenix due to eventual consistency.
post
/api/v1/urltopay
get
This endpoint will GET the UrlToPay object from Phoenix. Intended for internal CE use only
put
/api/v1/urltopay/{id}
put
/api/v1/urltopay/{id}/paymentdetails/{paymentId}
get
/api/v1/urltopay/enabled
Version
2
get
Get the current Advantage version number.
get
Get the current Advantage version number.
WaiverDocument
1
get
Gets a document, such as a PDF, for a waiver.
Waivers
5
get
Get a list of waivers.
post
Create a waiver.
get
Get a single waiver by ID.
put
Update an existing waiver.
get
Get a list of potential matching customer records for a waiver signee and dependents.
WaiverSignature
1
get
Gets a signature, such as an image, for a waiver.
WaiverText
1
get
Get a single waiver text by id
WaiverTypes
2
get
Get a single waiver type by id.
get
Get a list of waiver types.
Activities
get
/api/v1/activities
Query parameters
Name
string
skip
integer
take
integer
Response
Success
Activity[]
required
id
string
uuid
areaId
string
uuid
names
StringSet
maxCapacity
integer
reservedCapacity
integer
allowMixedUse
boolean
Changes