/
Equipment

Equipment

Get equipment

Equipment available to current user.

Request

Query parameters

Filters equipment by a specific location ID

If LocationID is not specified, only accessible equipment for the currently authenticated loyalty/retail user will be returned.

Response

Field Name

Type

Description

Notes

ID

int

Equipment Rec ID

 

EquipName

string

Equipment name

 

EquipClass

int

Equipment class type

0 = Unknown
1 = Washer
2 = Dryer
3 = Washer&Dryer
4 = Kiosk
5 = Door
6 = Vending
7 = SelfTest
8 = Demo
9 = PointOfSale

Options

List of EquipOption

Equipment options

Field Name

Type

Description

Notes

OptionNo

int

Option number

 

OptionType

int

Option type

0 = Base Price
1 = Adder Price
2 = Feature

Name

string

Option name

 

SupportsDualPocket

bool

Equipment support dual pocket readers

 

GET  /api/Equip

Equipment pricing

Get equipment pricing at location group

Request

Path parameters

The ID of the equipment.

The ID of the location group.

Response

Field Name

Type

Description

Notes

DefaultPrices

List of Option Prices

Default option prices

Field Name

Type

Description

Notes

OptionType

int

(Optional) Option type

0 = Base Price
1 = Adder Price
May leave empty/unset/null and will be automatically determined from equipment configuration

OptionNo

int

Option number

Must correspond to equipment configuration

OptionPrice

Decimal

Option price

Value given as currency (5.01 = $5.01)

For prices to default to free, can specify with OptionPrice as 0.00 or simply do not include

Schedule

List of Scheduled Options

Scheduled options

Field Name

Type

Description

Notes

StartTime

int

Start of pricing in minutes from Sunday 12:00 AM

Range from 0 to 10079

Duration

int

Duration of pricing in number of minutes

Range from 1 to 10079

Options

List of Option Prices

Option prices

 

Field Name

Type

Description

Notes

OptionType

int

(Optional) Option type

0 = Base Price
1 = Adder Price
May leave empty/unset/null and will be automatically determined from equipment configuration

OptionNo

int

Option number

Must correspond to equipment configuration

OptionPrice

Decimal

Option price

Value given as currency (5.01 = $5.01)

 

For prices that match default, can specify with OptionPrice matching default or simply do not include

GET /api/Equip/{equipID}/LocationGroup/{locGrpID}/Pricing
-or-
GET /api/LocationGroup/{locGrpID}/Equip/{equipID}/Pricing

Get equipment pricing for a specific location

Request

Path parameters

The ID of the equipment.

The ID of the location.

Response

Response returned same as LocationGroup PricingGET.

GET /api/Equip/{equipID}/Location/{locID}/Pricing
-or-
GET /api/Location/{locID}/Equip/{equipID}/Pricing

Edit equipment pricing at a location group

Request

Path parameters

The ID of the equipment.

The ID of the location group.

Request Body

See GET /api/Equipresponse for JSON body

POST /api/Equip/{equipID}/LocationGroup/{locGrpID}/Pricing
-or-
POST /api/LocationGroup/{locGrpID}/Equip/{equipID}/Pricing

Edit equipment pricing at a location

Note this will only be accepted if single Location in LocationGroup

Requirements: Account Admin or 'Equipment Setup' privilege

Request

Path parameters

The ID of the equipment.

The ID of the location.

Request Body

See GET /api/Equipresponse for JSON body

POST /api/Equip/{equipID}/Location/{locID}/Pricing
-or-
POST /api/Location/{locID}/Equip/{equipID}/Pricing

Get equipment schedules

Retrieve pricing and feature schedule information about a particular equipment at a location

Requirements: Account Admin or 'Equipment Setup' privilege

Request

Path parameters

The ID of the equipment.

The ID of the location.

Response

Field Name

Type

Description

Notes

EquipID

int

Equipment Rec ID

 

LocationID

int

Location Rec ID

 

DefaultTime

int

First time at which all options are at their defaults

 

Schedule

List of EquipOption

Equipment schedules

 

Field Name

Type

Description

Notes

StartTime

int

Start of schedule in minutes from Sunday 12:00 AM

 

EndTime

int

End of schedule in minutes from Sunday 12:00 AM

 

Prices

List of Price

Equipment pricing schedules

 

Field Name

Type

Description

Notes

Name

string

Option name

 

OptionNo

int

Option number

0 = Base Price
1 = Adder Price

OptionPrice

Decimal

Option price

Value given in cents

 

Features

List of Feature

Equipment features schedules

 

Field Name

Type

Description

Notes

Name

string

Feature name

Text description of Feature Number

FeatureNo

int

Feature number

0 = Machine Start
1 = Discount
2 = Points Multiplier
3 = Free Start

Value

int

Feature value

 

Feature Number

Meaning

0, 1

0 = Disabled
1 = Enabled

2

0-100 = Percentage

3

<0 = Redeem
0 = Disabled
>0 = Earn

 

 

 

GET /api/Equip/{equipID}/Schedule/{locID}
-or-
GET /api/Equip/{equipID}/Location/{locID}/Schedule
-or-
GET /api/Location/{locID}/Equip/{equipID}/Schedule