更新赛事
更新时间:2024-05-15
接口说明
本接口用来更新赛事的信息。
备注:
(1)增量修改,只会更新传入的参数;主设备deviceId不支持修改。
(2)赛事开始前,仅支持修改赛事时间、赛事名称、赛事描述、回调地址、转推地址、贴片信息、增加多机位。
(3)赛事进行中,仅支持修改赛事名称、赛事描述、回调地址、转推地址、贴片信息、增加多机位。
(4)赛事结束后,字段都不支持修改。
(5)赛事需要在创建时预先指定贴片模板ID,否则更新赛事贴片,无预先指定模板ID,贴片将不生效。
(6)赛事进行中,修改贴片会立即生效。添加未使用槽位的贴片会触发更新,添加已使用槽位的贴片会触发增加。
(7)赛事进行中, 可修改结束时间提前结束比赛或者延长赛事时间。
(8)多机位时,部分从设备处理错误不会影响方法报错,处理错误信息会通过secondaryDevicesErrInfoList返回。
请求
请求路径
Path | Method | 说明 |
---|---|---|
/v1/event/{id} | PUT | 更新赛事信息 |
请求参数
无
请求头
无其他特殊头域
请求体
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
name | String | 赛事name | N |
sportType | String | 赛事类型 | N |
description | String | 赛事描述 | N |
startTime | Long | 赛事开始时间,秒级时间戳 | N |
endTime | Long | 赛事结束时间,秒级时间戳 | N |
media | Object | 媒体信息 | N |
callbackUrl | String | 事件回调url | N |
graphics | Object | 贴片配置 | N |
+patternId | String | 贴片样式模板id | N |
+team | Object | 队伍信息 | N |
+scoreboard | List | 比分板 | N |
+clock | List | 计时器 | N |
+text | List | 文本配置 | N |
+image | List | 图片水印配置 | N |
响应
响应头域
除公共头域外,无其他特殊头域
响应体
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
Event | Object | 赛事信息 | |
+id | String | 赛事ID | |
+ .... | ..... | 详见Event实体信息 | |
errorMessage | String | 错误信息 | |
secondaryDevicesErrInfoList | List | 多机位错误信息 | 存在多机位时,且处理错误时返回 |
+deviceId | String | 多机位设备ID | |
+errorMessage | string | 该设备处理中产生的报错信息 |
示例
-
请求示例
PUT /v1/event/event-aaaaaa1 HTTP/1.1 host: {host} content-type: application/json authorization: {authorization} { "name":"修改后的赛事名称", "graphics":{ "image":[ { "index":2, "imageUrl":"http://xxx.2_new.jpg" } ] } } // 该请求修改了赛事名称和index=2图片槽位的图片
-
响应示例
HTTP/1.1 200 OK x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2 Date: Tue, 08 Now 2023 15:00:00 GMT Content-Type: application/json;charset=UTF-8 { "event": { "id":"event-aaaaaa1", "userId":"xxx", "deviceId":"device-aaaaaa1", "secondaryDeviceIDList":["device-thirdParty", "device_bbbb1"], "name":"测试后的赛事名称", "state":"notStarted", "sportType":"volleyball", "startTime":1667890800, "endTime":1667898000, "media":{ "liveStream":[ "1080p" ], "recording":[ "1080p" ], "mediaState":"liveStreamUnready", "forwardUrl":[ "rtmp://xxxx/xxxx/xxxxxxxx" ] }, "graphics":{ "patternId":"pattern-1", "team":{ "homeTeam":{ "name":"非凡排球", "boxColor":"#FF0000" }, "awayTeam":{ "name":"沙排联盟", "boxColor":"#FFFF00" } }, "scoreboard":[ { "index":1, "homeTeamScore":2, "awayTeamScore":4 }, { "index":2, "homeTeamScore":5, "awayTeamScore":10 } ], "text":[ { "index":1, "content":"三亚沙滩排球\"甘伯杯\"2023年预选赛" } ], "image":[ { "index":1, "imageUrl":"http://xxx.1.jpg" }, { "index":2, "imageUrl":"http://xxx.2_new.jpg" }, { "index":3, "imageUrl":"http://xxx.3.jpg" } ] } } }