RemoveReceiver

July 21, 2025

This API can be used to remove a replication receiver and may help to remove when the GUI cannot.

The settings can be found on the AhsayCBS web console at:

  • Replication > Accepting Data > Receiver

URL

https://CBS.EXAMPLE.COM/rps/api/json/RemoveReceiver.do

Available Since Version: 9.1

Parameters

Key Type Description
SysUser String Username of an AhsayCBS System User with Admin or API role.
SysPwd String Password matching SysUser.
Id Long Use ListReceiver.do to obtain the response output from existing ‘Id’, then pass it back using UpdateReceivers.do with your changes.
Return Values
Key Type Description
Status String "OK" or "Error"
Message String Error message, it only appears if status displays "Error".
ExptType String The type of exception, will only be displayed if the status is "Error".
Example

INPUT

{
	"SysUser":"system",
	"SysPwd":"system1",
	"Id":"1"
}

OUTPUT

{
	"Status":"OK"
}
Documentation