Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetLayoutInfo

int ctMemphisGetLayoutInfo( pRCESJson request, ppRCESJson result )

Description:

Retrieve a list of LayoutInfo (or a single LayoutInfo from the Replication Manager Database).

HTTP URL: <baseURL>/ctMemphisGetLayoutInfo/

HTTP Verb: POST

Parameters:

  • request [IN] - Remove Site request in JSON format. For example:

{

"layoutId":1 // required, if = -1 retrieve all the LayoutInfo.

Currently only -1 is supported

"paging": true, // optional, see Note 1 - Paging Parameters

"limit": 100, // optional, see Note 1 - Paging Parameters

"start": 200 // optional, see Note 1 - Paging Parameters

}

  • result [OUT] - Result in JSON format. For example:

{

"layoutInfoList": [

{

"id": 1,

"description": "Desc 1",

"layoutIdx": 2, // layout number

"zoom": 80, // zoom level

},

{

"id": 2,

"description": "Desc 2",

"layoutIdx": 2, // layout number

"zoom": 100, // zoom level

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

},

"total": 2 // total number of Layouts for the query -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex