BazeField Services

<back to all web services

SubscribeMeasurements

Measurement API
Requires Authentication
The following routes are available for this service:
GET,POST/api/measurements/{Keys}/subscribeObsolete
GET,POST/api/measurements/subscribe
SubscribeMeasurements Parameters:
NameParameterData TypeRequiredDescription
Keyspathstring[]No
EnableBufferingbodyboolNo
RequestedSamplingRatebodyint?No
SubscriptionPingRatebodyint?No
ClientRequestHandlebodystringNo
SubscribeReplyList Parameters:
NameParameterData TypeRequiredDescription
measurementsformMeasurement[]No
serverSubcriptionHandleformstringNo
replyInfoformReplyInfoNo
Measurement Parameters:
NameParameterData TypeRequiredDescription
ValueformTimeSeriesValueNo
MeasurementIdformintNo
ErrorformstringNo
TimeSeriesValue Parameters:
NameParameterData TypeRequiredDescription
tformlongNo
qformintNo
vformObjectNo
t_localformDateTimeOffset?No
ReplyInfo Parameters:
NameParameterData TypeRequiredDescription
RcvTimeformdoubleNo
ReplyTimeformdoubleNo
ClientRequestHandleformstringNo
ErrorformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/measurements/{Keys}/subscribe HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	keys: 
	[
		String
	],
	enableBuffering: False,
	requestedSamplingRate: 0,
	subscriptionPingRate: 0,
	clientRequestHandle: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	measurements: 
	[
		{
			value: 
			{
				t: 0,
				q: 0,
				v: {},
				t_local: 0001-01-01T00:00:00.0000000+00:00
			},
			measurementId: 0,
			error: String
		}
	],
	serverSubcriptionHandle: String,
	replyInfo: 
	{
		rcvTime: 0,
		replyTime: 0,
		clientRequestHandle: String,
		error: String
	}
}