LASC External API Usage

General URL format

http://server:port/api/version/format/data/param1/parma2
Where

server is the server host.
port is the server port.
version is the API version.
format the returned data format.
data is the data type being requested.
param1 is a parameter being supplied to the request.
param2 is another parameter being supplied to the request.

Version

The version string is in the form of v1.5.x.x and the current version of the API is 1.5.0.114.

Format

The format string determines what format the data is returned in. The API can currently provide data in the following formats:

json data is returned in the JSON format.
csv data is returned in comma separated values format.
html data is returned in html format.

Data

The data being requested. The following data is available via the api:

Paramaters

A parameter to the request. Different data requests have different parameter sets.

INS Instant

Returned Data

Field	Type	Unit	Description
mode	integer	LN270 mode word	The LN270 mode word.
status	integer	LN270 status word	The LN270 status word.
roll	float	degree	The roll angle.
pitch	float	degree	The pitch angle.
yaw	float	degree	The yaw angle.
shearerSpeed	float	m/s	The speed of the shearer.
shearerDirection	integer	0 towards MG 1 toward TG	The direction of the shearer.
shearerOdometry	float	m
rightDrum	integer	mm
leftDrum	integer	mm
logTime	integer	unix timestamp	Timestamp record was logged by the SPMS.
tstamp	string	timestamp	Timestamp when the record was received on the surface.

Examples

Current record

INS Log

URL

http://server:port/api/version/format/inslog/id/limit

Description

Returns the log of the INS mode and status. Note that this data is not linked to odometry changes and it will be updated when the values change.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The id of the record to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/1000	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	Record ID
mode	integer	LN270 mode word
status	integer	LN270 status word
logTime	integer	unix timestamp	Timestamp record was logged by the SPMS.
tstamp	string	timestamp	Timestamp when the record was received on the surface.

Examples

Last 10 records

Profile Data

URL

http://server:port/api/version/format/profiles/id/limit

Description

Returns the profile data records. Note these records contain the meta data relating to the profiles not the profile themselves.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The id of the profile record to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/no limit	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	Profile ID
status	integer	Bit flags
leadLag	integer	mm	The lead or lag applied to this profile. Note this data will be cleared when the profile is rebuilt.
creep	integer	mm	Not currently implemented.
retreat	integer	mm	Not currently implemented.
altitude	float	m	The maingate altitude.
logTime	integer	unix timestamp	Timestamp first maingate record was logged by the SPMS.
tstamp	string	timestamp	Timestamp when the profile was built and logged into the database.

Examples

Last 10 profiles

Cut Model Data

URL

http://server:port/api/version/format/cutmodel/id

Description

Returns the cut model data for a profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit
odometry	float	m
roll	float	deg
pitch	float	deg
yaw	float	deg
easting	float	m
northing	float	m
floor	float	m
roof	float	m

Examples

Current profile
Previous profile

Face Profiles

URL

http://server:port/api/version/format/faces/id/limit

Description

Returns the face profiles.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/100	The number of records to return.

Returned Data

Field	Type	Unit	Description
support	integer	support number
face	integer	mm	Each column represents a face profile with the header row containing the profile ID.

Examples

Last 50 profiles

Face Profile

URL

http://server:port/api/version/format/face/id

Description

Returns the face profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
support	integer	support number
face	integer	mm

Examples

Current profile
Previous profile

Desired Profile

URL

http://server:port/api/version/format/facedesired/id

Description

Returns the desired face profiles entered by the user. Note that these profiles will be cleared on database rebuild.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
support	integer	support number
desired	integer	mm

Examples

Current profile
Previous profile

All Face Profiles

URL

http://server:port/api/version/format/faceall/id

Description

Returns the face and desired profiles.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit
support	integer	support number
face	integer	mm
desired	integer	mm

Examples

Current profile
Previous profile

Horizon Profile

URL

http://server:port/api/version/format/horizon/id

Description

Returns the horizon profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
horizon floor	float	m	Absolute height.
horizon roof	float	m	Relative height from floor.

Examples

Current profile
Previous profile

Snapped Horizon Profile

URL

http://server:port/api/version/format/horizonsnapped/id

Description

Returns the snapped horizon profile where the maingate and tailgate are zeroed.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
snapped floor	float	m	Absolute height.
snapped roof	float	m	Relative height from floor.

Examples

Current profile
Previous profile

Predicted Horizon Profile

URL

http://server:port/api/version/format/horizonpredicted/id

Description

Returns the predicted horizon profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
predicted floor	float	m	Absolute height.
predicted roof	float	m	Relative height from floor.

Examples

Current profile
Previous profile

Required Horizon Profile

URL

http://server:port/api/version/format/horizonrequired/id

Description

Returns the required horizon profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
required floor	float	m	Absolute height.
required roof	float	m	Relative height from floor.

Examples

Current profile
Previous profile

Horizon Adjustments Profile

URL

http://server:port/api/version/format/horizonadjustments/id

Description

Returns the horizon adjustments profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
adjustments floor	float	mm	Absolute height.
adjustments roof	float	mm	Relative height from floor.

Examples

Current profile
Previous profile

Horizon Adjustments Profile

URL

http://server:port/api/version/format/horizongradients/id

Description

Returns the horizon adjustments profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit
odometry	float	m
gradients floor	float	deg
gradients roof	float	deg

Examples

Current profile
Previous profile

Horizon Desired Profile

URL

http://server:port/api/version/format/horizondesired/id

Description

Returns the desired horizon profile.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit
odometry	float	m
desired floor	float	m
desired roof	float	m

Examples

Current profile
Previous profile

All Horizon s

URL

http://server:port/api/version/format/horizonall/id

Description

Returns all horizon profiles.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).

Returned Data

Field	Type	Unit	Description
odometry	float	m
horizon floor	float	m	Absolute height.
horizon roof	float	m	Relative height from floor.
desired floor	float	m
desired roof	float	m
snapped floor	float	m	Absolute height.
snapped roof	float	m	Relative height from floor.
predicted floor	float	m	Absolute height.
predicted roof	float	m	Relative height from floor.
required floor	float	m	Absolute height.
required roof	float	m	Relative height from floor.
gradients floor	float	deg
gradients roof	float	deg
gradients floor	float	deg
gradients roof	float	deg
desired floor	float	m
desired roof	float	m

Examples

Current profile
Previous profile

OEM Log

URL

http://server:port/api/version/format/oemlog/id/source/limit

Description

Returns OEM communications log records.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The id of the record to return. -1 returns the current record (-2 previous record etc).
source	integer	-1/na	The record source type to return. -1 returns all record types 0 returns RPC records 1 returns Face Profile records 2 returns Horizon Adjustment records 3 returns Extracted Floor records 4 returns Floor Gradient records
limit	integer	1/20	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	Record ID
type	integer	source type	As per request parameter description.
sequence	integer	Profile ID	LASC current profile ID when data was transmitted. Note that this may differ from the sequence number transmitted in the data payload (i.e. when error payloads are transmitted).
result	integer	EIP error code
data	string	hex	The data payload as a hex string.
timestamp	string	timestamp

Examples

Last 10 records
Last 10 RPC records

Event Log

URL

http://server:port/api/version/format/events/id/source/limit

Description

Returns event log records.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The id of the event to return. -1 returns the current record (-2 previous record etc).
source	integer	-1/na	The event source to return records for. -1 returns all sources 1 returns SPMS Client event records 2 returns NDP event records 3 returns OCD event records 4 returns OEM Interface event records 5 returns MUPS event records 6 returns IIB event records 7 returns SPMS event records 8 returns Montioring Service event records 256 returns LASC event records 257 returns Face Alignment event records 258 returns Horizon Control event records 515 returns non control OCD event records
limit	integer	1/1000	The number of event records to return.

Returned Data

Field	Type	Unit	Description
id	integer	Event ID
source	integer	event source type	As per request parameter description.
code	integer	event code
type	integer	event type
description	string		Description of the event
data	string		Any debug data associated with the event.
timestamp	string	timestamp	Timestamp when the event was generated.
logged	string	timestamp	Timestamp when the event record was logged to the database.

Examples

Last 10 records
Last 10 SPMS Client events

Status

URL

http://server:port/api/version/format/status/source

Description

Returns the current status of the LASC system.

Request Parameters

Field	Type	Default/Max	Description
source	integer	-1/na	The component to the status of. -1 returns all components 1 returns the SPMS Client component 2 returns the NDP component 3 returns the OCD component 4 returns the OEM Interface component 5 returns the MUPS component 6 returns the IIB component 7 returns the SPMS component 8 returns the Montioring Service component 256 returns the LASC component 257 returns the Face Alignment component 258 returns the Horizon Control component 515 returns the non control OCD component

Returned Data

Field	Type	Unit	Description
componentId	integer	component id	As per request parameter description.
statusId	integer	status id
name	string	component name
description	string		Description of status.
state	integer	state id
stateDescription	string		Description of the current state.
logged	string	timestamp	Timestamp when the state first occured.
updated	string	timestamp	Timestamp when the state last occured.

Examples

Current status
Current status of the OCD component

Panel Information

URL

http://server:port/api/version/format/panelinfo

Description

Returns the panel information.

Request Parameters

None

Returned Data

Field	Type	Unit
name	string
status	integer	status word
mode	string	cutting mode
orientation	string	Maingate orientation
width	integer	m
heading	float	deg
easting	float	m
northing	float	m
zone	string
altitude	float	m
length	float	m
supports	integer	number of supports
advance	float	m
discontThreshold	integer	m
mgEntry	integer	m
mgExit	integer	m
tgEntry	integer	m
tgExit	integer	m
pointsPerMetre	integer	m
shearerLeft	integer	m
shearerRight	integer	m
shearerOffset	float	m

Examples

Panel Information

Requested Position Correction Records

URL

http://server:port/api/version/format/rpc/id/limit

Description

Returns the a RPC record.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/45	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	record number
sequence number	integer	LASC profile id
eip result	integer	EIP result code
timestamp	string	timestamp
first column	integer	support number	First column represents the support number
rpc	integer	mm	Each subsequent column represents a RPC profile.

Examples

Last 5 profiles

Face Profile Records

URL

http://server:port/api/version/format/fp/id/limit

Description

Returns the a FP record.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/45	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	record number
sequence number	integer	LASC profile id
eip result	integer	EIP result code
timestamp	string	timestamp
first column	integer	support number	First column represents the support number
rpc	integer	mm	Each subsequent column represents a FP profile.

Examples

Last 5 profiles

Horizon Adjustment Records

URL

http://server:port/api/version/format/ha/id/limit

Description

Returns the a HA record.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/45	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	record number
sequence number	integer	LASC profile id
eip result	integer	EIP result code
timestamp	string	timestamp
first column	integer	index number	First column represents the index.
mg floor	integer	mm	Maingate floor.
mg roof	integer	mm	Maingate roof.
tg floor	integer	mm	Tailgate floor.
tg roof	integer	mm	Tailgate roof.

Examples

Last 5 profiles

Extracted Floor Records

URL

http://server:port/api/version/format/ef/id/limit

Description

Returns the a EF record.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/45	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	record number
sequence number	integer	LASC profile id
eip result	integer	EIP result code
veritical offset	integer
timestamp	string	timestamp
first column	integer	index	First column represents the index number
ef	integer	mm	Each subsequent column represents a EF profile.

Examples

Last 5 profiles

Floor Gradient Records

URL

http://server:port/api/version/format/fg/id/limit

Description

Returns the a FG record.

Request Parameters

Field	Type	Default/Max	Description
id	integer	-1/na	The profile id to return. -1 returns the current record (-2 previous record etc).
limit	integer	1/45	The number of records to return.

Returned Data

Field	Type	Unit	Description
id	integer	record number
sequence number	integer	LASC profile id
eip result	integer	EIP result code
timestamp	string	timestamp
first column	integer	index	First column represents the index number
floor gradient	integer
roof offset	integer

Examples

Last 5 profiles