BazeField Services

SubscriptionPolledRefresh

Measurement API

The following routes are available for this service:
GET,POST	/api/measurements/subscription/{Handles}

**SubscriptionPolledRefresh** Parameters:
Name	Parameter	Data Type	Required
Handles	path	string[]	No
HoldTime	body	string	No
WaitTime	body	int	No
ReturnAllMeasurements	body	bool	No
ClientRequestHandle	body	string	No

**SubscribePolledRefreshReplyList** Parameters:
Name	Parameter	Data Type	Required
measurementList	form	SubscribePolledRefreshReply[]	No
dataBufferOverflow	form	bool	No
replyInfo	form	ReplyInfo	No

**SubscribePolledRefreshReply** Parameters:
Name	Parameter	Data Type	Required
measurements	form	Measurement[]	No
serverSubcriptionHandle	form	string	No
error	form	string	No

**Measurement** Parameters:
Name	Parameter	Data Type	Required
Value	form	TimeSeriesValue	No
MeasurementId	form	int	No
Error	form	string	No

**TimeSeriesValue** Parameters:
Name	Parameter	Data Type	Required
t	form	long	No
q	form	int	No
v	form	Object	No
t_local	form	DateTimeOffset?	No

**ReplyInfo** Parameters:
Name	Parameter	Data Type	Required
RcvTime	form	double	No
ReplyTime	form	double	No
ClientRequestHandle	form	string	No
Error	form	string	No

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/subscription/{Handles} HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	handles: 
	[
		String
	],
	holdTime: String,
	waitTime: 0,
	returnAllMeasurements: False,
	clientRequestHandle: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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