Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 2.42 KB

agreements.rst

File metadata and controls

76 lines (47 loc) · 2.42 KB

Example for Agreement

Agreement ownership change

Let's view transfer example for agreement transfer.

Getting agreement's credentials

At first let's get agreement credentials:

.. http:example:: tutorial/get-agreement-credentials.http
   :code:

broker is current agreement's owner.

Note that response's access section contains a transfer key which is used to change tender ownership.

After agreement's credentials obtaining broker has to provide its customer with transfer key.

Transfer creation

First of all, you must know ID of the agreement that you want to transfer.

Broker that is going to become new agreement owner should create a Transfer.

.. http:example:: tutorial/create-agreement-transfer.http
   :code:

Transfer object contains new access token and new transfer token for the object that will be transferred to new broker.

Changing agreement's owner

An ability to change agreement's ownership depends on agreement's status:

Allowed Not Allowed
active

pending

terminated

In order to change agreement's ownership new broker should send POST request to appropriate /agreements/id/ with data section containing id of Transfer and transfer token received from customer:

.. http:example:: tutorial/change-agreement-ownership.http
   :code:

Updated owner value indicates that ownership is successfully changed.

Note that new broker has to provide its customer with new transfer key (generated in Transfer object).

After Transfer is applied it stores agreement path in usedFor property.

.. http:example:: tutorial/get-used-agreement-transfer.http
   :code:

Let's try to change the agreement using token received on Transfer creation:

.. http:example:: tutorial/modify-agreement.http
   :code:

Pay attention that only broker with appropriate accreditation level can become new owner. Otherwise broker will be forbidden from this action.

.. http:example:: tutorial/change-agreement-ownership-forbidden.http
   :code:

Also ownership change is allowed only if current owner has a special accreditation level that allows ownership change:

.. http:example:: tutorial/change-agreement-ownership-forbidden-owner.http
   :code: