Skip to content

Commit

Permalink
Add docs for querying Rights history
Browse files Browse the repository at this point in the history
  • Loading branch information
sohkai committed Feb 10, 2017
1 parent 8694da9 commit 45eeed2
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,3 +343,36 @@ conform to the [user model](#create-users).
To check if your POST was successful, follow the steps in [registering a
manifestation](#was-my-post-to-manifestations-successful) and use the returned
Right's data instead.


### Querying the ownership history of a Right

The ownership history of a Right is represented as an time-series array of
ownership events (sorted from the initial creation of the entity), each in the
form of:

```json
{
"user": {
"publicKey": "<public key of the owner>",
"privateKey": null
},
"refId": "<transaction id of the transaction detailing the ownership event>"
}
```

Note that, as in the recipient (`to`) of a Rights transfer, the returned user
models only contain their public information.

```
GET /api/v1/rights/<ID of an existing right>
RETURNS:
[{
"user": {
"publicKey": "<public key of the owner>",
"privateKey": null
},
"refId": "<transaction id of the transaction detailing the ownership event>"
}, ...]
```

0 comments on commit 45eeed2

Please sign in to comment.