All Products
Search
Document Center

Blockchain as a Service:DescribeFabricInvitationCode

Last Updated:Aug 18, 2023

You can call this operation to obtain the invitation link.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeFabricInvitationCode

The operation that you want to perform. Set the value to DescribeFabricInvitationCode.

ConsortiumIdStringYesconsortium-lianmenyumingyi-hc5d1bwl****

The ID of the consortium.

RegionIdStringNocn-hangzhou

The ID of the region.

Response parameters

ParameterTypeExampleDescription
DynamicCodeStringInvitationCodeNotFound

The error identifier.

DynamicMessageStringThe invitation code could not found.

The error message.

ErrorCodeInteger200

The error code.

RequestIdString77E25463-56CB-4F1C-8EB6-8ADDFE39EF0F

The ID of the API request.

Result

The list of the invitation links.

AcceptedBooleantrue

Indicates whether the invitation is accepted. A value of true indicates that the invitation is accepted. A value of false indicates that the invitation is not accepted.

CodeStringcode

The invitation code.

ConsortiumIdStringconsortium-lianmenyumingyi-hc5d1bwlulg7

The ID of the consortium.

EmailStringabc@example.com

The Email address.

ExpireTimeString1544411108000

The expiration time..

InvitationIdInteger2

The invitation ID.

SendTimeString1544411108000

The time when the invitation was sent.

SenderBidString27534

The business ID of the user who sent the invitation.

SenderIdLong26345345

The ID of the user who sent the invitation.

SenderNameStringuid-35324

The user who sent the invitation.

UrlStringhttp://baas.console.aliyun.test/invite?code=92e7ef1934892

The invitation link.

SuccessBooleantrue

Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeFabricInvitationCode
&ConsortiumId=consortium-lianmenyumingyi-hc5d1bwl****
&<Common request parameters>

Successful response examples

XML format

<DescribeFabricInvitationCodeResponse>
  <Result>
		    <Url>http://baas.console.aliyun.test/invite?code=92e7ef1934892f272537d750c743a3d1be773038c97a8414065d63551a742b81</Url>
		    <ExpireTime>2018-06-14T15:10:11.000+0000</ExpireTime>
		    <Accepted>true</Accepted>
		    <Code>code</Code>
		    <ConsortiumId>consortium-lianmenyumingyi-hc5d1bwlulg7</ConsortiumId>
		    <Email>abc@example.com</Email>
		    <InvitationId>2</InvitationId>
		    <SendTime>2018-06-14T15:10:11.000+0000</SendTime>
		    <SenderId>126467457</SenderId>
		    <SenderBid>3563</SenderBid>
		    <SenderName>name</SenderName>
	  </Result>
	  <RequestId>9CFDE6E9-3835-4C2E-BECD-7CF20F5B5DD7</RequestId>
	  <Success>true</Success>
	  <ErrorCode>200</ErrorCode>
</DescribeFabricInvitationCodeResponse>

JSON format

{
	"Result":{
		"SenderBid":"3563",
		"Email":"abc@example.com",
		"ConsortiumId":"consortium-lianmenyumingyi-hc5d1bwlulg7",
		"Url":"http://baas.console.aliyun.test/invite?code=92e7ef1934892f272537d750c743a3d1be773038c97a8414065d63551a742b81",
		"InvitationId":2,
		"Accepted":"true",
		"ExpireTime":"2018-06-14T15:10:11.000+0000",
		"SendTime":"2018-06-14T15:10:11.000+0000",
		"SenderId":126467457,
		"SenderName":"name",
		"Code":"code"
	},
	"RequestId":"9CFDE6E9-3835-4C2E-BECD-7CF20F5B5DD7",
	"ErrorCode":200,
	"Success":true
}

Error codes

For more information about error codes, see Error codes.