This resource represents locations.

Operations

Get all locations for user

Locations available to current user

GET /api/Location

Get location

Get a location by ID.

Request

Path parameters

The ID of the location.

Response

Field Name	Type	Description	Notes

Field Name

Type

Description

Notes

ID

int

Location Rec ID

AccountID

int

SysConfig Account ID

AccountNumber

string

SysConfig Account Number

Fxxxx

LocationGroupID

int

LocationGroup ID

Enabled

bool

Location is enabled

Name

string

Location name

Addr1

string

Address #1

Addr2

string

Address #2

City

string

City

State

string

State

ZipCode

string

Zip code

Phone

string

Location phone number

Amenities

string

Location amenities

TimeZone

string

Location time zone

Latitude

Decimal

Location address latitude

May be 0.0 if incomplete address

Longitude

Decimal

Location address longitude

LogoImageExists

bool

Image exists for location or Account

ThemeColor1

string

Branding theme color #1

Colors stored as hex color code e.g. "#1c2e53" (always 7 characters with leading '#' char)

ThemeColor2

string

Branding theme color #2

CouponExists

bool

One or more coupons exist for location

RegOpts

Registration Options

Required registration options

Field Name	Type	Description
Name	bool	Name is required
Phone	bool	Phone is required
Address	bool	Address is required
Birthday	bool	Birthday is required
Message	string	Message to display to user when required registration details are not set

CMR

CMR Settings

Cellular Modem Router settings

null if not used at location

Field Name	Type	Description	Notes
Plan	int	CMR Plan ID	1 = Backup 2 = Primary
Type	int	CMR Type ID	1 = Verizon4G
Device	int	Device type	0 = Unknown 1 = Encore EN-1000 2 = MikroTik wAP LTE 3 = InRouter300
Sim	string	SIM ICCID

GET /api/Location/{locID}

Get location logo

This returns the raw binary data of the location's logo image or falls back to Account's logo image. It is represented as base64 data and can be displayed through html: <img src="data:image;base64,{{response}}" />

Request

Path parameters

The ID of the location.

GET /api/Location/{locID}/LogoImage

Get location groups for user

LocationGroups available to current user

GET /api/LocationGroup

Get location group

LocationGroup by ID

Request

Path parameters

The ID of the location group.

Response

Field Name	Type	Description	Notes

Field Name	Type	Description
`ID`	int	LocationGroup ID
`AccountID`	int	SysConfig Account ID
`Name`	string	LocationGroup name

GET /api/LocationGroup/{locGrpID}