Send or Save Mapping by JSON

555

# Send or Save Mapping by JSON

Path:

/api/rcv_layout

Method: POST

Content-type: application/json; charset=utf-8

API Description: This can be used to send or save the receiving card parameters as JSON.

Request Body

Name Type Example Description
rcvCount int 1 Receiving card count.
rcvRegions List - Parameter array of the receiving card.
portCount int 1 Port count in the receiving card parameters.
isSend bool false Indicate if the mapping has been sent. False by default.

rcvRegion

Name Type Example Description
portIndex int 0 Port number, starting from 0.
rcvIndex int 0 Receiving card count, starting from 0.
x int 0 X-coordinate.
y int 0 Y-coordinate.
width int 100 Width.
height int 100 Height.

Request Example PATH method

{
	"rcvCount": 2,
    "portCount": 1,
	"rcvRegions": [{
		"portIndex": 0,
		"rcvIndex": 0,
		"x": 0,
		"y": 0,
		"width": 220,
		"height": 248
	}, {
		"portIndex": 0,
		"rcvIndex": 1,
		"x": 220,
		"y": 0,
		"width": 220,
		"height": 248
	}]
}

Response

Name Type Example Description
errorCode int 0 Error code.
apiErrorCode int 0 API error code.

Response Example

{
    "errorCode": 0,
    "apiErrorCode":0
}