BazeField Services

<back to all web services

SubscriptionPolledRefresh

Measurement API
Requires Authentication
The following routes are available for this service:
GET,POST/api/measurements/subscription/{Handles}
SubscriptionPolledRefresh Parameters:
NameParameterData TypeRequiredDescription
Handlespathstring[]No
HoldTimebodystringNo
WaitTimebodyintNo
ReturnAllMeasurementsbodyboolNo
ClientRequestHandlebodystringNo
SubscribePolledRefreshReplyList Parameters:
NameParameterData TypeRequiredDescription
measurementListformSubscribePolledRefreshReply[]No
dataBufferOverflowformboolNo
replyInfoformReplyInfoNo
SubscribePolledRefreshReply Parameters:
NameParameterData TypeRequiredDescription
measurementsformMeasurement[]No
serverSubcriptionHandleformstringNo
errorformstringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"handles":["String"],"holdTime":"String","waitTime":0,"returnAllMeasurements":false,"clientRequestHandle":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}