Load RelationshipTemplate created by others

This use case loads a peer’s RelationshipTemplate from the Backbone by a given reference to the RelationshipTemplate.

Parameters

There are two different options to use this use case, depending on the actual information received by the peer:

• by knowing a truncatedReference of the peer’s RelationshipTemplate (RelationshipTemplateReferenceTruncated)
  • reference as string
• by knowing a truncatedReference of the peer’s Token, which references to the peer’s RelationshipTemplate (TokenReferenceTruncated)
  • reference as string

If the RelationshipTemplate or the Token, if there is one, is protected by a password via the passwordProtection property, it must be entered with the password parameter of this use case in order to be authorized to load the RelationshipTemplate.

On Success

• Returns the RelationshipTemplate.

On Failure

• The parameters are malformed.
• The RelationshipTemplate does not exist.
• The RelationshipTemplate is expired.
• The maxNumberOfAllocations of the RelationshipTemplate are depleted.
• The RelationshipTemplate is personalized for a different Identity via the property forIdentity of the RelationshipTemplate.
• No password or an incorrect password was entered in case of a password protected RelationshipTemplate or a password protected Token, if there is one.

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: