Help Center/ Blockchain Service/ API Reference/ APIs (Enhanced Hyperledger Fabric)/ BCS Consortium/ Inviting Tenants to Join a Consortium
Updated on 2023-04-26 GMT+08:00
View PDF
Share

Inviting Tenants to Join a Consortium

Function

This API is used to invite multiple tenants in batches to join a channel. This operation will send invitation notifications to the invitees.

URI

POST /v2/{project_id}/members/invitations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token.

Minimum: 1

Maximum: 32768
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

bcs_id

Yes

String

BCS service ID of the inviting party.

channel_name

Yes

String

Name of the channel in the invitation.

invitor_username

No

String

Tenant name of the inviting party.

invited_userinfo

Yes

Array of InvitedDomain objects

List of invitees.
Table 4 InvitedDomain

Parameter

Mandatory

Type

Description

invited_user

Yes

String

Name of the invitee.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

String

Result of a successful request.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 10 Response body parameters

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" : "ba0fc16d-c752-9ac4-7a43-7a84443e0a06",
  "channel_name" : "channel",
  "invitor_username" : "paas_bcs_c00218797_02",
  "invited_userinfo" : [ {
    "invited_user" : "xxx"
  } ]
}

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.

Parent topic: BCS Consortium