diff --git a/README.md b/README.md index 6195cce..e030975 100644 --- a/README.md +++ b/README.md @@ -279,7 +279,7 @@ PAYLOAD: "publicKey": "", "privateKey": "" }, - "sourceRightId": "" + "sourceRightId": "" } RETURNS: @@ -296,3 +296,44 @@ RETURNS: 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. + + +### Transfer a Right + +You may only transfer a Right that you are currently holding. RightsAssignment +entities are automatically created for each transfer and may include additional, +arbitrary attributes if a `rightsAssignment` dict is given in the payload. + +``` +POST /api/v1/rights/transfer +HEADERS {"Content-Type": "application/json"} + +PAYLOAD: +{ + "rightId": "", + "rightsAssignment": { + ... + }, + "currentHolder": { + "publicKey": "", + "privateKey": "" + }, + "to": { + "publicKey": "", + "privateKey": "" + } +} + +RETURNS: +{ + "rightsAssignment": { + "@id": "", + "@type": "RightsTransferAction", + ... (provided `rightsAssignment`) + } +} +``` + +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.