Announcement
大约 3 分钟
注:
有关本“公告”功能,其本意是服务于:
- 当机厅遇到机身损坏、断电、断网、举办比赛等特殊情况分享;
- 失物招领、机厅群宣传等非盈利性质信息的发布。
API管理员会不定时检查公告内容,如有违规内容(如色情内容、商业性质广告)或无意义灌水会删除,严重者禁用本功能使用权限。
根URL:
/place/{cityName}/{placeName}/announcement
POST createAnnouncement
createAnnouncement
子URI:
根据地点名(或别名)(可模糊查找)为指定地点创建公告。一条公告在创建后不可修改,只能删除后重新创建。响应值是创建的公告信息。
一条公告在未被续期的情况下,在创建后7天后过期。公告过期后将会被删除。
注: API管理员会不定时检查公告创建记录,对于创建包含违规信息(包括但不限于色情内容、商业性质广告)的公告以及发布无意义灌水公告的人,将会禁用其公告功能,严重者将禁用本API的访问权限。有关本条规则强烈建议为用户说明。
Parameters
| 参数类型 | 字段名 | 数据类型 | 是否必须 | 说明 | 
|---|---|---|---|---|
| Path | cityName | String | 是 | 准确省市全称 | 
| Path | placeName | String | 是 | 模糊地点名/别名 | 
| Body | uploaderId | Long | 是 | 发布者QQ号 | 
| Body | uploaderGroupId | Long | 是 | 发布者QQ群号 | 
| Body | announcementContent | String | 是 | 公告内容,不能为null或空字符串 | 
Responses
| 字段名 | 数据类型 | 说明 | 
|---|---|---|
| announcementId | Long | 公告ID | 
| uploaderId | Long | 发布者QQ号 | 
| uploaderGroupId | Long | 发布者QQ群号 | 
| announcementContent | String | 公告内容 | 
| createTime | Datetime | 公告发布时间 | 
| expireTime | Datetime | 公告过期时间 | 
| place | Object | 对应地点 | 
| > placeId | Integer | 地点ID | 
| > placeName | String | 地点全称 | 
Examples
 200 OK: POST: /place/安徽省合肥市/风云/announcement
{
    "code": 0,
    "msg": "success",
    "data": {
        "announcementId": 3,
        "uploaderId": 123456,
        "uploaderGroupId": 123456789,
        "announcementContent": "测试公告",
        "createTime": [
            2023,
            4,
            4,
            14,
            2,
            12
        ],
        "expireTime": [
            2023,
            4,
            11,
            14,
            2,
            12
        ],
        "place": {
            "placeId": 1,
            "placeName": "风云再起淮河路店"
        }
    }
}
PUT renewalAnnouncement
renewalAnnouncement
子URI:
/{announcementId}/renewal
根据地点名(或别名)(可模糊查找)为指定地点的指定ID的公告续期一周。响应值是创建的公告信息。
Parameters
| 参数类型 | 字段名 | 数据类型 | 是否必须 | 说明 | 
|---|---|---|---|---|
| Path | cityName | String | 是 | 准确省市全称 | 
| Path | placeName | String | 是 | 模糊地点名/别名 | 
| Path | announcementId | Long | 是 | 目标公告ID | 
| Body | operatorId | Long | 是 | 发布者QQ号 | 
Responses
| 字段名 | 数据类型 | 说明 | 
|---|---|---|
| announcementId | Long | 公告ID | 
| uploaderId | Long | 发布者QQ号 | 
| uploaderGroupId | Long | 发布者QQ群号 | 
| announcementContent | String | 公告内容 | 
| createTime | Datetime | 公告发布时间 | 
| expireTime | Datetime | 公告过期时间 | 
| place | Object | 对应地点 | 
| > placeId | Integer | 地点ID | 
| > placeName | String | 地点全称 | 
Examples
 200 OK: POST: /place/安徽省合肥市/风云/announcement/3/renewal
{
    "code": 0,
    "msg": "success",
    "data": {
        "announcementId": 3,
        "uploaderId": 123456,
        "uploaderGroupId": 123456789,
        "announcementContent": "测试公告",
        "createTime": [
            2023,
            4,
            4,
            14,
            2,
            12
        ],
        "expireTime": [
            2023,
            4,
            18,
            14,
            2,
            12
        ],
        "place": {
            "placeId": 1,
            "placeName": "风云再起淮河路店"
        }
    }
}
DELETE deleteAnnouncement
deleteAnnouncement
子URI:
/{announcementId}
根据地点名(或别名)(可模糊查找)为指定地点删除指定ID的公告。响应值是被删除的公告信息。
注: 只有公告创建者本人以及API管理员可以删除公告。
Parameters
| 参数类型 | 字段名 | 数据类型 | 是否必须 | 说明 | 
|---|---|---|---|---|
| Path | cityName | String | 是 | 准确省市全称 | 
| Path | placeName | String | 是 | 模糊地点名/别名 | 
| Path | announcementId | Long | 是 | 目标公告ID | 
| Body | deleterId | Long | 是 | 删除者QQ号 | 
Responses
| 字段名 | 数据类型 | 说明 | 
|---|---|---|
| announcementId | Long | 公告ID | 
| uploaderId | Long | 发布者QQ号 | 
| uploaderGroupId | Long | 发布者QQ群号 | 
| announcementContent | String | 公告内容 | 
| createTime | Datetime | 公告发布时间 | 
| expireTime | Datetime | 公告过期时间 | 
| place | Object | 对应地点 | 
| > placeId | Integer | 地点ID | 
| > placeName | String | 地点全称 | 
Examples
 200 OK: DELETE: /place/安徽省合肥市/风云/announcement/3
{
    "code": 0,
    "msg": "success",
    "data": {
        "announcementId": 3,
        "uploaderId": 123456,
        "uploaderGroupId": 123456789,
        "announcementContent": "测试公告",
        "createTime": [
            2023,
            4,
            4,
            14,
            2,
            12
        ],
        "expireTime": [
            2023,
            4,
            11,
            14,
            2,
            12
        ],
        "place": {
            "placeId": 1,
            "placeName": "风云再起淮河路店"
        }
    }
}