If you succeeded an OwnIdentityAttribute, whose previous version you shared with a peer, you can decide to inform the peer about the succession. If you do so, the peer will receive a Notification via Message, which handles the succession of their PeerIdentityAttribute. This means, a new version of the PeerIdentityAttribute will be created and the predecessor will be updated to link to this successor in its succeededBy property. Note that it is possible to notify a peer about the succession of an OwnIdentityAttribute you already shared with them, even if you didn’t inform them about every previous version. In this case, the succeeds field of the newly created PeerIdentityAttribute will link to the latest shared version. Moreover, it is also possible to notify a peer about the succession of an OwnIdentityAttribute if this in turn is already succeeded again, in case you didn’t notify the peer about a newer version, yet.

Parameters

  • attributeId of the OwnIdentityAttribute successor.
  • The address of the peer.

On Success

  • The response returns a predecessor and a successor OwnIdentityAttribute, as well as the notificationId of the Notification sent to the peer.
  • The predecessor is the OwnIdentityAttribute that was shared with the peer most recently.
  • The successor is the OwnIdentityAttribute successor about which the peer is to be informed.

On Failure

  • The response cannot be created if the peer is unknown.
  • The response cannot be created if the attributeId doesn’t belong to an OwnIdentityAttribute.
  • The response cannot be created if you already notified the peer about the succession of the OwnIdentityAttribute.
  • The response cannot be created if you already shared the OwnIdentityAttribute successor or a newer version with the peer.
  • The response cannot be created if you haven’t shared any version of the OwnIdentityAttribute with the peer before or if the AttributeForwardingDetails of the latest previous version you have shared with the peer before have "DeletedByRecipient" as deletionInfo.deletionStatus. To initially share an OwnIdentityAttribute, use the Share OwnIdentityAttribute use case.
  • The response cannot be created if the parameters are malformed.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use case. This use case can be executed with the REST API of the Connector which you can Access the Connector.
Corresponding interactive API docs excerpt: