PUT api/customer/{clientId}/heartbeat

Allows Client to post heartbeat messages to the API to indicate that it is still running and provide status updates and logs

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Identifies the Net Health Customer associated with the Client	string	Required

Body Parameters

Heartbeat data, including status and logs

Collection of ProfileHeartbeatData

Name	Type	Additional information
ProfileId	integer	None.
ProfileType	ProfileType	None.
ServerStatus	ServerStatus	None.
LastTransactionId	string	None.
LastTransactionDateTime	date	None.
LastError	string	None.
LastErrorDateTime	date	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "ProfileId": 1,
    "ProfileType": 1,
    "ServerStatus": 1,
    "LastTransactionId": "sample string 2",
    "LastTransactionDateTime": "2024-11-25T07:51:02.2345912-05:00",
    "LastError": "sample string 3",
    "LastErrorDateTime": "2024-11-25T07:51:02.2345912-05:00"
  },
  {
    "ProfileId": 1,
    "ProfileType": 1,
    "ServerStatus": 1,
    "LastTransactionId": "sample string 2",
    "LastTransactionDateTime": "2024-11-25T07:51:02.2345912-05:00",
    "LastError": "sample string 3",
    "LastErrorDateTime": "2024-11-25T07:51:02.2345912-05:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProfileHeartbeatData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Interface.Relay.TransferObjects">
  <ProfileHeartbeatData>
    <LastError>sample string 3</LastError>
    <LastErrorDateTime>2024-11-25T07:51:02.2345912-05:00</LastErrorDateTime>
    <LastTransactionDateTime>2024-11-25T07:51:02.2345912-05:00</LastTransactionDateTime>
    <LastTransactionId>sample string 2</LastTransactionId>
    <ProfileId>1</ProfileId>
    <ProfileType>Inbound</ProfileType>
    <ServerStatus>Started</ServerStatus>
  </ProfileHeartbeatData>
  <ProfileHeartbeatData>
    <LastError>sample string 3</LastError>
    <LastErrorDateTime>2024-11-25T07:51:02.2345912-05:00</LastErrorDateTime>
    <LastTransactionDateTime>2024-11-25T07:51:02.2345912-05:00</LastTransactionDateTime>
    <LastTransactionId>sample string 2</LastTransactionId>
    <ProfileId>1</ProfileId>
    <ProfileType>Inbound</ProfileType>
    <ServerStatus>Started</ServerStatus>
  </ProfileHeartbeatData>
</ArrayOfProfileHeartbeatData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ProfileListResponseData

Name	Type	Additional information
InboundProfileList	Collection of RelayInboundProfile	None.
OutboundProfileList	Collection of RelayOutboundProfile	None.
ResponseStatus	ResponseStatus	None.
LogMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "InboundProfileList": [
    {
      "RelayInboundProfileID": 1,
      "RelayCustomerID": 2,
      "ProfileName": "sample string 3",
      "ApplicationName": "sample string 4",
      "Active": true,
      "ClientActionRequest": 64,
      "LogLevel": "sample string 6",
      "AlertEmailList": "sample string 7",
      "LogTransactionsToDB": true,
      "ReceiveTCP": true,
      "ReceivePort": 1,
      "ReceiveImmediateAck": true,
      "ReceiveFile": true,
      "ReceiveFileFolderPath": "sample string 11",
      "ReceiveFileExtension": "sample string 12",
      "ReceiveFilePollingInterval": 1,
      "RelayTCP": true,
      "RelayIPAddress": "sample string 14",
      "RelayPortNumber": 1,
      "RelayAckTimeout": 1,
      "RelayFile": true,
      "RelayFileFolderPath": "sample string 16",
      "RelayWebService": true,
      "RelayWebServiceURI": "sample string 18",
      "RelayWebServiceTimeout": 1,
      "ServerStatus": 64,
      "LastTransactionDateTime": "2024-11-25T07:51:02.359579-05:00",
      "PendingHeartbeatCommand": 64,
      "LastHeartbeatDateTime": "2024-11-25T07:51:02.359579-05:00"
    },
    {
      "RelayInboundProfileID": 1,
      "RelayCustomerID": 2,
      "ProfileName": "sample string 3",
      "ApplicationName": "sample string 4",
      "Active": true,
      "ClientActionRequest": 64,
      "LogLevel": "sample string 6",
      "AlertEmailList": "sample string 7",
      "LogTransactionsToDB": true,
      "ReceiveTCP": true,
      "ReceivePort": 1,
      "ReceiveImmediateAck": true,
      "ReceiveFile": true,
      "ReceiveFileFolderPath": "sample string 11",
      "ReceiveFileExtension": "sample string 12",
      "ReceiveFilePollingInterval": 1,
      "RelayTCP": true,
      "RelayIPAddress": "sample string 14",
      "RelayPortNumber": 1,
      "RelayAckTimeout": 1,
      "RelayFile": true,
      "RelayFileFolderPath": "sample string 16",
      "RelayWebService": true,
      "RelayWebServiceURI": "sample string 18",
      "RelayWebServiceTimeout": 1,
      "ServerStatus": 64,
      "LastTransactionDateTime": "2024-11-25T07:51:02.359579-05:00",
      "PendingHeartbeatCommand": 64,
      "LastHeartbeatDateTime": "2024-11-25T07:51:02.359579-05:00"
    }
  ],
  "OutboundProfileList": [
    {
      "RelayOutboundProfileID": 1,
      "RelayCustomerID": 2,
      "ProfileName": "sample string 3",
      "ApplicationName": "sample string 4",
      "Active": true,
      "ClientActionRequest": 64,
      "LogLevel": "sample string 6",
      "AlertEmailList": "sample string 7",
      "WebServicePollingInterval": 8,
      "TransactionLimitPerRequest": 1,
      "RelayTCP": true,
      "RelayIPAddress": "sample string 10",
      "RelayPortNumber": 1,
      "RelayAckTimeout": 1,
      "RelayFile": true,
      "RelayFileFolderPath": "sample string 12",
      "ServerStatus": 64,
      "LastTransactionDateTime": "2024-11-25T07:51:02.3752062-05:00",
      "PendingHeartbeatCommand": 64,
      "LastHeartbeatDateTime": "2024-11-25T07:51:02.3752062-05:00"
    },
    {
      "RelayOutboundProfileID": 1,
      "RelayCustomerID": 2,
      "ProfileName": "sample string 3",
      "ApplicationName": "sample string 4",
      "Active": true,
      "ClientActionRequest": 64,
      "LogLevel": "sample string 6",
      "AlertEmailList": "sample string 7",
      "WebServicePollingInterval": 8,
      "TransactionLimitPerRequest": 1,
      "RelayTCP": true,
      "RelayIPAddress": "sample string 10",
      "RelayPortNumber": 1,
      "RelayAckTimeout": 1,
      "RelayFile": true,
      "RelayFileFolderPath": "sample string 12",
      "ServerStatus": 64,
      "LastTransactionDateTime": "2024-11-25T07:51:02.3752062-05:00",
      "PendingHeartbeatCommand": 64,
      "LastHeartbeatDateTime": "2024-11-25T07:51:02.3752062-05:00"
    }
  ],
  "ResponseStatus": 1,
  "LogMessage": "sample string 1"
}

application/xml, text/xml

Sample:

<ProfileListResponseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Interface.Relay.TransferObjects">
  <LogMessage>sample string 1</LogMessage>
  <ResponseStatus>Success</ResponseStatus>
  <InboundProfileList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Interface.Relay.DataAccess">
    <d2p1:RelayInboundProfile>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AlertEmailList>sample string 7</d2p1:AlertEmailList>
      <d2p1:ApplicationName>sample string 4</d2p1:ApplicationName>
      <d2p1:ClientActionRequest>64</d2p1:ClientActionRequest>
      <d2p1:LastHeartbeatDateTime>2024-11-25T07:51:02.359579-05:00</d2p1:LastHeartbeatDateTime>
      <d2p1:LastTransactionDateTime>2024-11-25T07:51:02.359579-05:00</d2p1:LastTransactionDateTime>
      <d2p1:LogLevel>sample string 6</d2p1:LogLevel>
      <d2p1:LogTransactionsToDB>true</d2p1:LogTransactionsToDB>
      <d2p1:PendingHeartbeatCommand>64</d2p1:PendingHeartbeatCommand>
      <d2p1:ProfileName>sample string 3</d2p1:ProfileName>
      <d2p1:ReceiveFile>true</d2p1:ReceiveFile>
      <d2p1:ReceiveFileExtension>sample string 12</d2p1:ReceiveFileExtension>
      <d2p1:ReceiveFileFolderPath>sample string 11</d2p1:ReceiveFileFolderPath>
      <d2p1:ReceiveFilePollingInterval>1</d2p1:ReceiveFilePollingInterval>
      <d2p1:ReceiveImmediateAck>true</d2p1:ReceiveImmediateAck>
      <d2p1:ReceivePort>1</d2p1:ReceivePort>
      <d2p1:ReceiveTCP>true</d2p1:ReceiveTCP>
      <d2p1:RelayAckTimeout>1</d2p1:RelayAckTimeout>
      <d2p1:RelayCustomerID>2</d2p1:RelayCustomerID>
      <d2p1:RelayFile>true</d2p1:RelayFile>
      <d2p1:RelayFileFolderPath>sample string 16</d2p1:RelayFileFolderPath>
      <d2p1:RelayIPAddress>sample string 14</d2p1:RelayIPAddress>
      <d2p1:RelayInboundProfileID>1</d2p1:RelayInboundProfileID>
      <d2p1:RelayPortNumber>1</d2p1:RelayPortNumber>
      <d2p1:RelayTCP>true</d2p1:RelayTCP>
      <d2p1:RelayWebService>true</d2p1:RelayWebService>
      <d2p1:RelayWebServiceTimeout>1</d2p1:RelayWebServiceTimeout>
      <d2p1:RelayWebServiceURI>sample string 18</d2p1:RelayWebServiceURI>
      <d2p1:ServerStatus>64</d2p1:ServerStatus>
    </d2p1:RelayInboundProfile>
    <d2p1:RelayInboundProfile>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AlertEmailList>sample string 7</d2p1:AlertEmailList>
      <d2p1:ApplicationName>sample string 4</d2p1:ApplicationName>
      <d2p1:ClientActionRequest>64</d2p1:ClientActionRequest>
      <d2p1:LastHeartbeatDateTime>2024-11-25T07:51:02.359579-05:00</d2p1:LastHeartbeatDateTime>
      <d2p1:LastTransactionDateTime>2024-11-25T07:51:02.359579-05:00</d2p1:LastTransactionDateTime>
      <d2p1:LogLevel>sample string 6</d2p1:LogLevel>
      <d2p1:LogTransactionsToDB>true</d2p1:LogTransactionsToDB>
      <d2p1:PendingHeartbeatCommand>64</d2p1:PendingHeartbeatCommand>
      <d2p1:ProfileName>sample string 3</d2p1:ProfileName>
      <d2p1:ReceiveFile>true</d2p1:ReceiveFile>
      <d2p1:ReceiveFileExtension>sample string 12</d2p1:ReceiveFileExtension>
      <d2p1:ReceiveFileFolderPath>sample string 11</d2p1:ReceiveFileFolderPath>
      <d2p1:ReceiveFilePollingInterval>1</d2p1:ReceiveFilePollingInterval>
      <d2p1:ReceiveImmediateAck>true</d2p1:ReceiveImmediateAck>
      <d2p1:ReceivePort>1</d2p1:ReceivePort>
      <d2p1:ReceiveTCP>true</d2p1:ReceiveTCP>
      <d2p1:RelayAckTimeout>1</d2p1:RelayAckTimeout>
      <d2p1:RelayCustomerID>2</d2p1:RelayCustomerID>
      <d2p1:RelayFile>true</d2p1:RelayFile>
      <d2p1:RelayFileFolderPath>sample string 16</d2p1:RelayFileFolderPath>
      <d2p1:RelayIPAddress>sample string 14</d2p1:RelayIPAddress>
      <d2p1:RelayInboundProfileID>1</d2p1:RelayInboundProfileID>
      <d2p1:RelayPortNumber>1</d2p1:RelayPortNumber>
      <d2p1:RelayTCP>true</d2p1:RelayTCP>
      <d2p1:RelayWebService>true</d2p1:RelayWebService>
      <d2p1:RelayWebServiceTimeout>1</d2p1:RelayWebServiceTimeout>
      <d2p1:RelayWebServiceURI>sample string 18</d2p1:RelayWebServiceURI>
      <d2p1:ServerStatus>64</d2p1:ServerStatus>
    </d2p1:RelayInboundProfile>
  </InboundProfileList>
  <OutboundProfileList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Interface.Relay.DataAccess">
    <d2p1:RelayOutboundProfile>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AlertEmailList>sample string 7</d2p1:AlertEmailList>
      <d2p1:ApplicationName>sample string 4</d2p1:ApplicationName>
      <d2p1:ClientActionRequest>64</d2p1:ClientActionRequest>
      <d2p1:LastHeartbeatDateTime>2024-11-25T07:51:02.3752062-05:00</d2p1:LastHeartbeatDateTime>
      <d2p1:LastTransactionDateTime>2024-11-25T07:51:02.3752062-05:00</d2p1:LastTransactionDateTime>
      <d2p1:LogLevel>sample string 6</d2p1:LogLevel>
      <d2p1:PendingHeartbeatCommand>64</d2p1:PendingHeartbeatCommand>
      <d2p1:ProfileName>sample string 3</d2p1:ProfileName>
      <d2p1:RelayAckTimeout>1</d2p1:RelayAckTimeout>
      <d2p1:RelayCustomerID>2</d2p1:RelayCustomerID>
      <d2p1:RelayFile>true</d2p1:RelayFile>
      <d2p1:RelayFileFolderPath>sample string 12</d2p1:RelayFileFolderPath>
      <d2p1:RelayIPAddress>sample string 10</d2p1:RelayIPAddress>
      <d2p1:RelayOutboundProfileID>1</d2p1:RelayOutboundProfileID>
      <d2p1:RelayPortNumber>1</d2p1:RelayPortNumber>
      <d2p1:RelayTCP>true</d2p1:RelayTCP>
      <d2p1:ServerStatus>64</d2p1:ServerStatus>
      <d2p1:TransactionLimitPerRequest>1</d2p1:TransactionLimitPerRequest>
      <d2p1:WebServicePollingInterval>8</d2p1:WebServicePollingInterval>
    </d2p1:RelayOutboundProfile>
    <d2p1:RelayOutboundProfile>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:AlertEmailList>sample string 7</d2p1:AlertEmailList>
      <d2p1:ApplicationName>sample string 4</d2p1:ApplicationName>
      <d2p1:ClientActionRequest>64</d2p1:ClientActionRequest>
      <d2p1:LastHeartbeatDateTime>2024-11-25T07:51:02.3752062-05:00</d2p1:LastHeartbeatDateTime>
      <d2p1:LastTransactionDateTime>2024-11-25T07:51:02.3752062-05:00</d2p1:LastTransactionDateTime>
      <d2p1:LogLevel>sample string 6</d2p1:LogLevel>
      <d2p1:PendingHeartbeatCommand>64</d2p1:PendingHeartbeatCommand>
      <d2p1:ProfileName>sample string 3</d2p1:ProfileName>
      <d2p1:RelayAckTimeout>1</d2p1:RelayAckTimeout>
      <d2p1:RelayCustomerID>2</d2p1:RelayCustomerID>
      <d2p1:RelayFile>true</d2p1:RelayFile>
      <d2p1:RelayFileFolderPath>sample string 12</d2p1:RelayFileFolderPath>
      <d2p1:RelayIPAddress>sample string 10</d2p1:RelayIPAddress>
      <d2p1:RelayOutboundProfileID>1</d2p1:RelayOutboundProfileID>
      <d2p1:RelayPortNumber>1</d2p1:RelayPortNumber>
      <d2p1:RelayTCP>true</d2p1:RelayTCP>
      <d2p1:ServerStatus>64</d2p1:ServerStatus>
      <d2p1:TransactionLimitPerRequest>1</d2p1:TransactionLimitPerRequest>
      <d2p1:WebServicePollingInterval>8</d2p1:WebServicePollingInterval>
    </d2p1:RelayOutboundProfile>
  </OutboundProfileList>
</ProfileListResponseData>