POST /people/{personId}/site-membership-requests
基本信息
使用JSON正文中指定的id标识符在sites上为自己创建一个sites成员身份请求。 请求的结果因sites类型而异。
- 对于公共(public)sites,您可以立即作为SiteConsumer加入该sites。
- 对于受审核(moderated)的sites,您的请求将添加到v成员资格请求列表中。 该请求等待sites管理员的批准。
- 您不能请求私人(private)sites的成员身份。 成员由sites管理员邀请。
您可以使用-me-
字符串代替<personid>
来代表当前通过身份验证的用户。
Note:您可以通过在JSON正文中指定sites列表来为多个sites创建sites成员资格请求,如下所示:
[ { "message": "Please can you add me", "id": "test-site-1", "title": "Request for test site 1", }, { "message": "Please can you add me", "id": "test-site-2", "title": "Request for test site 2", } ]
如果将列表指定为输入,则在响应正文中返回分页列表而不是条目。 例如:
{ "list": { "pagination": { "count": 2, "hasMoreItems": false, "totalItems": 2, "skipCount": 0, "maxItems": 100 }, "entries": [ { "entry": { ... } }, { "entry": { ... } } ] } }
请求方式 :POST
请求API :/ people / {personId} / site-membership-requests
响应等级(状态201)
成功回应
{ "entry": { "id": "string", "createdAt": "2021-01-13T07:13:00.995Z", "site": { "id": "string", "guid": "string", "title": "string", "description": "string", "visibility": "PRIVATE", "preset": "string", "role": "SiteConsumer" }, "message": "string" } }
响应内容类型 applicaiton/json
Query参数
Path参数
名称 | 类型 | 是否必填 | 示例值 | 描述 |
personId | string | 是 | 个人的标识符。 |
Body参数(siteMembershipRequestBodyCreate)
request body示例
{ "message": "string", "id": "string", "title": "string" }
错误信息描述
状态码 | 原因 |
400 | 无效的参数:id无效,或已邀请用户,或siteMembershipRequestBodyCreate无效 |
401 | 验证失败 |
404 | personId或id不存在 |
default | 意外错误 |
返回结果示例
{ "error": { "errorKey": "string", "statusCode": 0, "briefSummary": "string", "stackTrace": "string", "descriptionURL": "string", "logId": "string" } }