# Receiver Highlight
This API can be used to enable or disable the highlight function for specified receiver cards.
# API Path
{CLTPlatform-ip}:8086/receiver/markPosition
- Replace
{CLTPlatform-ip}
with the corresponding IP address. - The request port is
8086
.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Type
of the request body toapplication/json
.
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | [string] | receiver/markPosition | ||
data | Data | Yes | [object] | |||
data>>senderIndex | Sender index (starts from 0) | Yes | [int] | 0 | ||
data>>portIndex | Network port index (starts from 0) | Yes | [int] | 0 | ||
data>>receiverIndex | Receiver card index (starts from 0) | Yes | [int] | 0 | ||
data>>bEnable | Whether to enable highlight | Yes | [boolean] | true |
# Request Example
{
"command": "receiver/markPosition",
"data": {
"senderIndex": 0,
"portIndex": 0,
"receiverIndex": 0,
"bEnable": true
}
}
# Response
Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
---|---|---|---|---|---|---|
command | Command type | Yes | [string] | receiver/markPosition | ||
code | Status code | Yes | [int] | 20000 | ||
message | Message | Yes | [string] | Common_Success | ||
data | Data | Yes | [object] |
# Response Example
{
"command": "receiver/markPosition",
"code": 20000,
"message": "Common_Success",
"data": {}
}