PUT api/profile/{relayCustomerProfileId}/heartbeatcommandresponse

Receives response from heartbeat command and clears command upon success

Request Information

URI Parameters

NameDescriptionTypeAdditional information
relayCustomerProfileId

integer

Required

Body Parameters

Response to heartbeat command

HeartbeatCommandResponseData
NameDescriptionTypeAdditional information
ProfileType

ProfileType

None.

Success

boolean

None.

Logs

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ProfileType": 1,
  "Success": true,
  "Logs": "sample string 2"
}

application/xml, text/xml

Sample:
<HeartbeatCommandResponseData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Interface.Relay.TransferObjects">
  <Logs>sample string 2</Logs>
  <ProfileType>Inbound</ProfileType>
  <Success>true</Success>
</HeartbeatCommandResponseData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>