Product Documentation

FairCom Replication JSON RPC API

Previous Topic

Next Topic

ctMemphisGetSites

int ctMemphisGetSites( pRCESJson request, ppRCESJson result )

Description:

Retrieve all the Sites from the Replication Manager Database.

HTTP URL: <baseURL>/ctMemphisGetSites/

HTTP Verb: POST

Parameters:

  • request [IN] - Get Sites request in JSON format. For example:

{

"id": 0, // optional, is passed, retrieve Site by ID

"name": "site1", // optional, is passed, retrieve

Site by Name

"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:

{

"siteList": [

{

"id": 1,

"name": "site1",

"type": "local",

"description": "site 1 description"

},

{

"id": 2,

"name": "site2",

"type": "local",

"description": "site 2 description"

}

]

"success": true,

"error":

{

"errorCode": 0,

"message": "Success"

}, "total": 500 // total number of sites -

see Note 1 - Paging Parameters

}

Return:

Error code

TOCIndex