GET v1/core/channels/{chnId}/events?count={count}

Return events for this channel - by default only one is returned

Request Information

Parameters

Name	Description	Additional information
chnId	Channel ID	Define this parameter in the request URI.
count	Max Number of events to read - default is 1	Define this parameter in the request URI.

Response Information

List of events

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": [
    {
      "ID": 1,
      "ChannelID": 2,
      "Timestamp": "2025-05-05T10:31:48.8643816+00:00",
      "ReadCount": 4,
      "Name": "sample string 5",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      }
    },
    {
      "ID": 1,
      "ChannelID": 2,
      "Timestamp": "2025-05-05T10:31:48.8643816+00:00",
      "ReadCount": 4,
      "Name": "sample string 5",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      }
    },
    {
      "ID": 1,
      "ChannelID": 2,
      "Timestamp": "2025-05-05T10:31:48.8643816+00:00",
      "ReadCount": 4,
      "Name": "sample string 5",
      "Parameters": {
        "sample string 1": {},
        "sample string 3": {},
        "sample string 5": {}
      }
    }
  ],
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":[{"ID":1,"ChannelID":2,"Timestamp":"2025-05-05T10:31:48.8643816+00:00","ReadCount":4,"Name":"sample string 5","Parameters":{"sample string 1":{},"sample string 3":{},"sample string 5":{}}},{"ID":1,"ChannelID":2,"Timestamp":"2025-05-05T10:31:48.8643816+00:00","ReadCount":4,"Name":"sample string 5","Parameters":{"sample string 1":{},"sample string 3":{},"sample string 5":{}}},{"ID":1,"ChannelID":2,"Timestamp":"2025-05-05T10:31:48.8643816+00:00","ReadCount":4,"Name":"sample string 5","Parameters":{"sample string 1":{},"sample string 3":{},"sample string 5":{}}}],"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfArrayOfChannelEventCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <ChannelEvent>
      <ChannelID>2</ChannelID>
      <ID>1</ID>
      <Name>sample string 5</Name>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Parameters>
      <ReadCount>4</ReadCount>
      <Timestamp>2025-05-05T10:31:48.8643816+00:00</Timestamp>
    </ChannelEvent>
    <ChannelEvent>
      <ChannelID>2</ChannelID>
      <ID>1</ID>
      <Name>sample string 5</Name>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Parameters>
      <ReadCount>4</ReadCount>
      <Timestamp>2025-05-05T10:31:48.8643816+00:00</Timestamp>
    </ChannelEvent>
    <ChannelEvent>
      <ChannelID>2</ChannelID>
      <ID>1</ID>
      <Name>sample string 5</Name>
      <Parameters xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 5</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Parameters>
      <ReadCount>4</ReadCount>
      <Timestamp>2025-05-05T10:31:48.8643816+00:00</Timestamp>
    </ChannelEvent>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfArrayOfChannelEventCA1DLPoZ>

application/bson

Sample:

sSuccessData0�IDChannelID	Timestamp�}��ReadCountNamesample string 5ParametersGsample string 1sample string 3sample string 51�IDChannelID	Timestamp�}��ReadCountNamesample string 5ParametersGsample string 1sample string 3sample string 52�IDChannelID	Timestamp�}��ReadCountNamesample string 5ParametersGsample string 1sample string 3sample string 5ErrorCodeErrorDescriptionsample string 3Metasample string 4