DescribeFabricInvitationCode - Blockchain as a Service - Alibaba Cloud Documentation Center

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

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeFabricInvitationCode	The operation that you want to perform. Set the value to DescribeFabricInvitationCode.
ConsortiumId	String	Yes	consortium-lianmenyumingyi-hc5d1bwl****	The ID of the consortium.

Response parameters

Parameter	Type	Example	Description
DynamicCode	String	InvitationCodeNotFound	The error identifier.
DynamicMessage	String	The invitation code could not found.	The error message.
ErrorCode	Integer	200	The error code.
RequestId	String	77E25463-56CB-4F1C-8EB6-8ADDFE39EF0F	The ID of the API request.
Result			The list of the invitation links.
Accepted	Boolean	true	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.
Code	String	code	The invitation code.
ConsortiumId	String	consortium-lianmenyumingyi-hc5d1bwlulg7	The ID of the consortium.
Email	String	abc@example.com	The Email address.
ExpireTime	String	1544411108000	The expiration time..
InvitationId	Integer	2	The invitation ID.
SendTime	String	1544411108000	The time when the invitation was sent.
SenderBid	String	27534	The business ID of the user who sent the invitation.
SenderId	Long	26345345	The ID of the user who sent the invitation.
SenderName	String	uid-35324	The user who sent the invitation.
Url	String	http://baas.console.aliyun.test/invite?code=92e7ef1934892	The invitation link.
Success	Boolean	true	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

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFabricInvitationCodeResponse>
    <DynamicMessage>The invitation code could not found.</DynamicMessage>
    <RequestId>77E25463-56CB-4F1C-8EB6-8ADDFE39EF0F</RequestId>
    <ErrorCode>200</ErrorCode>
    <Success>true</Success>
    <DynamicCode>InvitationCodeNotFound</DynamicCode>
    <Result>
        <SenderId>26345345</SenderId>
        <Email>abc@126.com</Email>
        <SenderBid>27534</SenderBid>
        <ExpireTime>1544411108000</ExpireTime>
        <ConsortiumId>consortium-lianmenyumingyi-hc5d1bwl****</ConsortiumId>
        <InvitationId>2</InvitationId>
        <SenderName>uid-35324</SenderName>
        <Code>code</Code>
        <Url>http://baas.console.aliyun.test/invite?code=92e7ef1934892</Url>
        <Accepted>true</Accepted>
        <SendTime>1544411108000</SendTime>
    </Result>
</DescribeFabricInvitationCodeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DynamicMessage" : "The invitation code could not found.",
  "RequestId" : "77E25463-56CB-4F1C-8EB6-8ADDFE39EF0F",
  "ErrorCode" : 200,
  "Success" : true,
  "DynamicCode" : "InvitationCodeNotFound",
  "Result" : {
    "SenderId" : 26345345,
    "Email" : "abc@126.com",
    "SenderBid" : "27534",
    "ExpireTime" : "1544411108000",
    "ConsortiumId" : "consortium-lianmenyumingyi-hc5d1bwl****",
    "InvitationId" : 2,
    "SenderName" : "uid-35324",
    "Code" : "code",
    "Url" : "http://baas.console.aliyun.test/invite?code=92e7ef1934892",
    "Accepted" : true,
    "SendTime" : "1544411108000"
  }
}

Error codes

For more information about error codes, see Error codes.