Fetch Server List Request (Optional)

Overview

Fetch Server List Request is an optional URL that allows Coda to fetch server lists by the get method.

Fetch Server List Response

The response of the fetch server list request from the publisher. It should include serverName, serverId, and isForTest. Below is an example:

Format: JSON

Format for one-level server list:

{
  "serverList": [
    {
      "serverName": "Test Server 1",
      "serverId": "0000001",
      "isForTest": 1
    },
    {
      "serverName": "Server 1",
      "serverId": "1000001",
      "isForTest": 0
    },
    {
      "serverName": "Server 2",
      "serverId": "1000002",
      "isForTest": 0
    }
  ]
}

Format for two-level server list:

{
  "serverList": {
    "Area 1": [
      {
        "serverName": "Server 1",
        "serverId": "1000001",
        "isForTest": 0
      },
      {
        "serverName": "Server 2",
        "serverId": "1000002",
        "isForTest": 0
      }
    ],
    "Area 2": [
      {
        "serverName": "Server 3",
        "serverId": "1000003",
        "isForTest": 0
      },
      {
        "serverName": "Server 4",
        "serverId": "1000004",
        "isForTest": 0
      }
    ]
  }
}
ParameterTypeDescription

serverName

String

Server Name

serverId

String

Server ID

isForTest

Integer

isForTest is a flag to indicate whether the current server is a test/sandbox server. If isTest is 1, this server is a sandbox/test server; if isTest is 0, this server is a production server.

If you encounter an error, please refer to our Error Codes list for more information.

Last updated