Deleting Invitation Information
Function
This API is used to cancel invitations in batches or delete information about rejected or dismissed invitations, or invitations where the members have quit.
URI
DELETE /v2/{project_id}/members/invitations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Account token. Minimum: 1 Maximum: 32768 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
bcs_id |
Yes |
String |
ID of the BCS service of the inviting party. |
channel_name |
Yes |
String |
Name of the channel in the invitation. |
invited_userinfo |
Yes |
Array of InvitationDetail objects |
List of invitees. The information can be queried using the ListMembers API. If an invitee has joined the consortium or the invitation status is released, enter the correct BCS service ID of the invitee and the invitation status. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
invited_user |
Yes |
String |
IAM user name of the invitee. |
status |
No |
String |
Invitation status. The options are as follows: quit, waiting, reject, and released. Invitation in other states cannot be deleted. Enumeration values:
|
invited_bcs_id |
No |
String |
BCS service ID of the invitee. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
result |
String |
Result of a successful request. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Example Requests
{ "bcs_id" : "83d85ea4-0f97-3bb7-07e2-4ad4b5a9f39d", "channel_name" : "chan2", "invited_userinfo" : [ { "invited_user" : "bcstest02", "status" : "quit", "invited_bcs_id" : "11ba0ae0-2986-72d5-9049-43998c16fe86" } ] }
Example Responses
Status code: 200
Ok
{ "result" : "success" }
Status code: 400
Bad Request
{ "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter quotasType : ecs" }
Status code: 401
Unauthorized
{ "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" }
Status code: 404
Not Found
{ "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" }
Status code: 500
InternalServerError
{ "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Ok |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
InternalServerError |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot