Call GetJournal to obtain the information of a journal.

Request parameters

Parameter Type Required Example Description
Action String Required GetJournal

The operation that you want to perform. Value: GetJournal
JournalId Long Yes 100

The ID of the record to be obtained.
LedgerId String Required l-c8cc7be3eea542axxxxxxxxxx

The Ledger ID of the operation.

Response parameters

Parameter Type Example Description
Journal Struct

The detailed information about the DNS record.
ClientId String xxxx

The client ID of the writer.
Clues List [clue1, clue2]

Record the list of relevant clues.
JournalHash String 04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b

Record the Hash.
JournalId String 100

The ID of the record.
LedgerId String l-c8cc7be3eea542axxxxxxxxxx

The ID of the ledger instance where the record is located.
MemberId String m-04389ec1075443bcxxxxxxxxxx

The ID of the record writer.
PayloadJsonString String xxxxxxxxxxxxxxxxxxxxx

Record content.
PayloadType String CUSTOM

The type of the DNS record. Valid values:

  • CUSTOM: CUSTOM operation
  • CREATE_LEDGER: Create an ledger.
  • DELETE_LEDGER: deletes the ledger.
  • UPDATE_LEDGER: Update the ledger.
  • CREATE_MEMBER: Creates a member.
  • DELETE_MEMBER: deletes a member.
  • UPDATE_MEMBER_KEY: updates the member public key.
  • UPDATE_MEMBER_PERMISSIONS: updates the member key.
  • ENABLE_MEMBER: the member to be restored.
  • DISABLE_MEMBER: the member is disabled.
  • SET_TRUST_POINT: Set a trust anchor.
  • CREATE_TIMEANCHOR: creates a time anchor.
  • KV_SET: sets a KEY.
  • KV_DELETE: deletes a KEY.
Timestamp Long 1587090122155

The time when the record was written. The number of milliseconds since January 1, 1970 (00:00 GMT).

RequestId String 89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetJournal
&JournalId=100
&LedgerId=l-c8cc7be3eea542axxxxxxxxxx
&<Common request parameters>

Sample success responses

XML format 

<RequestId>89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C</RequestId>
<Journal>
    <MemberId>m-04389ec1075443bcxxxxxxxxxx</MemberId>
    <JournalId>100</JournalId>
    <ClientId>xxxx</ClientId>
    <Clues>[clue1, clue2]</Clues>
    <LedgerId>l-c8cc7be3eea542axxxxxxxxxx</LedgerId>
    <JournalHash>04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b</JournalHash>
    <Timestamp>1587090122155</Timestamp>
    <PayloadType>xxxxxxxxxxxxxxxxxxxxx</PayloadType>
    <PayloadJsonString>CUSTOM_PAYLOAD</PayloadJsonString>
</Journal>

JSON format 

{
    "RequestId": "89E6B5F5-7511-46A7-9EDB-3C6F8AA4D48C",
    "Journal": {
        "MemberId": "m-04389ec1075443bcxxxxxxxxxx",
        "JournalId": 100,
        "ClientId": "xxxx",
        "Clues": "[clue1, clue2]",
        "LedgerId": "l-c8cc7be3eea542axxxxxxxxxx",
        "JournalHash": "04d45eb3bcbd2a47aeb5de87b73fd6a324bb7b57a081fd474a82d8dc7e830d42868aeb15a9fa02ac09205b68ecfc78e8e67c70c67736aa0e867a9a7011b83fab4b",
        "Timestamp": 1587090122155,
        "PayloadType": "xxxxxxxxxxxxxxxxxxxxx",
        "PayloadJsonString": "CUSTOM_PAYLOAD"
    }
}

Error codes

HttpCode Error code Error message Description
400 InvalidParameter The specified parameter %s is invalid. The error message returned because the specified parameters are invalid.
400 MissingParameter You must specify the parameter %s. The error message returned when the client token is not specified.
404 ResourceNotFound The specified resource %s does not exist. Resource not found
403 UnauthorizedOperation You are not authorized to perform this operation. %s No operation permissions

For a list of error codes, visit the API Error Center.