BazeField Services

SubscribeMeasurements

Measurement API

The following routes are available for this service:
GET,POST	/api/measurements/{Keys}/subscribe	Obsolete
GET,POST	/api/measurements/subscribe

**SubscribeMeasurements** Parameters:
Name	Parameter	Data Type	Required
Keys	path	string[]	No
EnableBuffering	body	bool	No
RequestedSamplingRate	body	int?	No
SubscriptionPingRate	body	int?	No
ClientRequestHandle	body	string	No

**SubscribeReplyList** Parameters:
Name	Parameter	Data Type	Required
measurements	form	Measurement[]	No
serverSubcriptionHandle	form	string	No
replyInfo	form	ReplyInfo	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 .xml suffix or ?format=xml

HTTP + XML

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

<SubscribeMeasurements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <ClientRequestHandle>String</ClientRequestHandle>
  <EnableBuffering>false</EnableBuffering>
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <RequestedSamplingRate>0</RequestedSamplingRate>
  <SubscriptionPingRate>0</SubscriptionPingRate>
</SubscribeMeasurements>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SubscribeReplyList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BazeField.Historian.DataServices">
  <measurements>
    <Measurement>
      <Error>String</Error>
      <MeasurementId>0</MeasurementId>
      <Value>
        <q>0</q>
        <t>0</t>
        <t_local xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </t_local>
        <v />
      </Value>
    </Measurement>
  </measurements>
  <replyInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.WebService.Common">
    <d2p1:ClientRequestHandle>String</d2p1:ClientRequestHandle>
    <d2p1:Error>String</d2p1:Error>
    <d2p1:RcvTime>0</d2p1:RcvTime>
    <d2p1:ReplyTime>0</d2p1:ReplyTime>
  </replyInfo>
  <serverSubcriptionHandle>String</serverSubcriptionHandle>
</SubscribeReplyList>