POST /sites/{siteId}/members
基本信息
更新sites siteId中personpersonId的成员资格。
您可以将 role设置为以下四种类型之一:
- sites消费者(SiteConsumer)
- sites协作者(SiteCollaborator)
- sites贡献者(SiteContributor)
- sites管理员(SiteManager)
Note: 您可以通过在JSON正文中指定人员列表来创建多个sites成员身份,如下所示:
[ { "role": "SiteConsumer", "id": "joe" }, { "role": "SiteConsumer", "id": "fred" } ]
如果将列表指定为输入,则在响应正文中返回分页列表而不是条目。 例如:
{ "list": { "pagination": { "count": 2, "hasMoreItems": false, "totalItems": 2, "skipCount": 0, "maxItems": 100 }, "entries": [ { "entry": { ... } }, { "entry": { ... } } ] } }
请求方式: POST
请求API :/ sites / {siteId} / members
响应等级(状态201)
成功回应
{ "entry": { "id": "string", "person": { "id": "string", "firstName": "string", "lastName": "string", "description": "string", "avatarId": "string", "email": "string", "skypeId": "string", "googleId": "string", "instantMessageId": "string", "jobTitle": "string", "location": "string", "company": { "organization": "string", "address1": "string", "address2": "string", "address3": "string", "postcode": "string", "telephone": "string", "fax": "string", "email": "string" }, "mobile": "string", "telephone": "string", "statusUpdatedAt": "2021-01-08T08:52:11.811Z", "userStatus": "string", "enabled": true, "emailNotificationsEnabled": true, "aspectNames": [ "string" ], "properties": {}, "capabilities": {} }, "role": "SiteConsumer" } }
响应内容类型 applicaiton/json
Query参数
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
siteId | string | 是 | sites的标识符。 |
Body参数(siteMembershipRejectionBody)
request body示例
{ "role": "SiteConsumer", "id": "string" }
错误信息描述
状态码 | 原因 |
400 | 无效的参数:role或id的值无效或siteMembershipBodyCreate无效 |
401 | 验证失败 |
403 | 当前用户无权拒绝会员请求 |
404 | siteId或personId不存在 |
409 | 具有此id的人已经是会员 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }