Help Center/ Blockchain Service/ Developer Guide/ Blockchain Middleware APIs/ Distributed Identity (OBT)/ Verifiable Credential (VC) Management/ Querying Open Application Orders
Updated on 2022-12-06 GMT+08:00
View PDF
Share

Querying Open Application Orders

Function

This API is used to query open VC application orders based on the service identifier. Only the service provider has the permission to query orders.

URI

POST /v1/identity/query-vc-orders

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

orgID

Yes

String

Organization ID.

channelID

Yes

String

Channel ID.

cryptoMethod

Yes

String

Encryption method, which is fixed at SW.

cert

Yes

String

User certificate. Add an explicit line break (\n) at the end of each line.

sk

Yes

String

User private key. Add an explicit line break (\n) at the end of each line.

timestamp

Yes

String

Timestamp.

serviceID

No

String

Service identifier.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

items

Array of VCOrder objects

List.
Table 3 VCOrder

Parameter

Type

Description

applyer

String

Applicant identifier.

orderSeq

String

Order number.

applyTime

String

Application time.

price

String

Price.

status

String

Status.

service

String

Service.

reason

String

Reason.

dataUri

String

VC data URI.

encryptedAesKey

String

Encrypted AES key.

uriType

String

URI type.

dataHash

String

Data hash value.

lockProof

String

Lock proof.

vcIndex

String

VC index.

Status code: 500

Table 4 Response body parameters

Parameter

Type

Description

errorCode

String

Error code.

Minimum: 8

Maximum: 36

errorMsg

String

Error description.

Minimum: 2

Maximum: 512

Example Requests

{
  "orgID" : "4f1439758ebb41f7411b5f684b67713c08b89198",
  "channelID" : "mychannel",
  "cryptoMethod" : "SW",
  "cert" : "-----BEGIN CERTIFICATE-----\n...\n...\n-----END CERTIFICATE-----",
  "sk" : "------BEGIN PRIVATE KEY-----\n...\n...\n-----END PRIVATE KEY-----",
  "timestamp" : "2020-10-27T17:28:16+08:00",
  "orderIndex" : 1
}

Example Responses

Status code: 200

UntreatedVCOrder Information List

{
  "items" : [ {
    "applyer" : "string",
    "orderSeq" : "string",
    "applyTime" : "string",
    "price" : "string",
    "status" : "string",
    "service" : "string",
    "reason" : "string",
    "dataUri" : "string",
    "encryptedAesKey" : "string",
    "uriType" : "string",
    "dataHash" : "string",
    "lockProof" : "string",
    "vcIndex" : "string"
  } ]
}

Status code: 500

Error response.

{
  "errorCode" : "stringst",
  "errorMsg" : "string"
}

Status Codes

Status Code

Description

200

UntreatedVCOrder Information List

500

Error response.

Error Codes

See Error Codes.