配置文件列表
警告: 这里的 API 文档适用于托管游戏服务器托管 (Clanforge)。如果您使用的是游戏服务器托管 (Multiplay)，请参阅 游戏服务器 API 文档。
获取所有 `<accountserviceid>` 的配置文件，并带有可选过滤器。
https://api.multiplay.co.uk/cfp/v1/profile/list方法 |
| GET |
请求参数
| 变量 | 描述 | 可选 |
| accountserviceid | `<accountserviceid>` 参数接受与指定资源关联的帐户服务 ID (ASID)。请求标头中的凭据必须对 ASID 具有访问权限才能执行请求。 | 否 |
| profileid | `<profileid>` 参数接受一个或多个配置文件 ID。如果您为此参数指定了值，则响应主体仅包含有关提供的配置文件 ID 的信息。 | 是 |
| modid | `<modid>` 参数接受一个或多个模组 ID。如果您为此参数指定了值，则响应主体仅包含有关与提供的模组 ID 关联的配置文件的信息。 | 是 |
| game_build | `<game_build>` 参数接受一个或多个游戏构建。如果您为此参数指定了值，则响应主体仅包含有关与提供的游戏构建关联的配置文件的信息。 | 是 |
| settings | `<settings>` 参数接受布尔值。 如果设置为 `true`，则每个配置文件在响应主体中包含设置信息。 如果设置为 `false` 或排除，则响应主体中不包含任何设置信息。 | 是 |
响应字段
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| profiles | 数组 | 配置文件对象的列表 | 否 |
配置文件对象
| 字段 | 类型 | 描述 | 可选 |
|---|---|---|---|
| profileid | 整数 | 配置文件的 ID | 否 |
| gameversionid | 整数 | 与该配置文件关联的游戏版本的 ID | 否 |
| name | 字符串 | 该配置文件的名称 | 否 |
| modid | 整数 | 与该配置文件关联的模组的 ID | 否 |
| gameid | 整数 | 与该配置文件关联的游戏的 ID | 否 |
| gametype_identifier | 字符串 | 该配置文件的游戏类型标识符 | 否 |
| settings | 对象 | 包含设置名称字符串到设置值字符串的映射 | 否 |
| fleetid | 字符串 | 与该配置文件关联的舰队 ID | 否 |
示例请求
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/profile/list?accountserviceid=<accountserviceid>&settings=<settings>&game_build=<game_build>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'示例响应
{
"profiles": [
{
"profileid": <profileid>,
"gameversionid": <gameversionid>,
"name": <name>,
"modid": <modid>,
"gameid": <gameid>,
"gametype_identifier": <gametype_identifier>,
"settings": {
"setting1": <setting_value>,
"setting2": <setting_value>,
...
},
"fleetid": <fleetid>
},
...
]
}