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 ProfileHeartbeatDataName | Description | 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": "2025-09-16T03:26:48.0755697-04:00", "LastError": "sample string 3", "LastErrorDateTime": "2025-09-16T03:26:48.0755697-04:00" }, { "ProfileId": 1, "ProfileType": 1, "ServerStatus": 1, "LastTransactionId": "sample string 2", "LastTransactionDateTime": "2025-09-16T03:26:48.0755697-04:00", "LastError": "sample string 3", "LastErrorDateTime": "2025-09-16T03:26:48.0755697-04:00" } ]
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
Response Information
Resource Description
ProfileListResponseDataName | Description | 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": "2025-09-16T03:26:48.0911933-04:00", "PendingHeartbeatCommand": 64, "LastHeartbeatDateTime": "2025-09-16T03:26:48.0911933-04: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": "2025-09-16T03:26:48.0911933-04:00", "PendingHeartbeatCommand": 64, "LastHeartbeatDateTime": "2025-09-16T03:26:48.0911933-04: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": "2025-09-16T03:26:48.0911933-04:00", "PendingHeartbeatCommand": 64, "LastHeartbeatDateTime": "2025-09-16T03:26:48.0911933-04: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": "2025-09-16T03:26:48.0911933-04:00", "PendingHeartbeatCommand": 64, "LastHeartbeatDateTime": "2025-09-16T03:26:48.0911933-04:00" } ], "ResponseStatus": 1, "LogMessage": "sample string 1" }
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.