Help Center/ Blockchain Service/ API Reference/ APIs (Enhanced Hyperledger Fabric)/ BCS Consortium/ Querying All Notifications
Updated on 2023-04-26 GMT+08:00
View PDF
Share

Querying All Notifications

Function

Querying All Notifications

URI

GET /v2/{project_id}/notifications

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

notifications

Array of NotificationList objects

Notification list.
Table 4 NotificationList

Parameter

Type

Description

channel_name

String

Channel name.

status

String

Current status.

updated_time

String

Update time.

tc3_need

Boolean

Whether trusted computing is enabled.

invitor_info

InvitorInfo object

Inviting party information.

invitee_info

InviteeInfo object

Invitee information.

hide

Long

Whether the notification has been deleted.

invitee_orgs

Array of OrganizationV2 objects

Information about the invitee's organizations.

read_status

Long

Reading status.

cross_version_upgrade

String

Cross-version upgrade.
Table 5 InvitorInfo

Parameter

Type

Description

invitor_id

String

ID of the inviting party.

invitor_name

String

Username of the inviting party.

invitor_bcs_id

String

BCS service ID of the inviting party.

invitor_bcs_name

String

BCS service name of the inviting party.

invitor_consensus

String

Consensus mechanism used by the inviting party.

invitor_project_id

String

Project ID of the inviting party.

invitor_cluster_type

String

Cluster type used by the inviting party.

invitor_database_type

String

Database type used by the inviting party.

invitor_signature_algorithm

String

Signature algorithm used by the inviting party.

invitor_fabric_version

String

Fabric version used by the inviting party.

order_fade_enabled

Boolean

Whether to enable data aging on orderers.

order_fade_cache

Long

Aging threshold of orderer data.
Table 6 InviteeInfo

Parameter

Type

Description

invitee_id

String

ID of the invitee.

invitee_name

Long

Name of the invitee.

invitee_bcs_name

String

BCS service name of the invitee.

invitee_bcs_id

String

BCS service ID of the invitee.

invitee_project_id

String

Project ID of the invitee.
Table 7 OrganizationV2

Parameter

Type

Description

name

String

Organization name.

name_hash

String

Hash value of the organization name.

node_count

Integer

Peers in the organization.

status

String

Status.

status_detail

String

Status description.

Status code: 400

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: 401

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: 403

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

Status code: 404

Table 11 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 12 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

None

Example Responses

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