Create outgoing Request

This use case is intended to create an actionable LocalRequest based on a given Request for a given peer. The created LocalRequest needs to be manually submitted to the peer, for example by sending it via a Message. One can and should check if the outgoing Request can be created before creating the LocalRequest with this use case, because a more precise error description is provided in the case of a faulty Request.

Parameters

• The content as a Request for the to be created LocalRequest.
• The peer is the address for which the LocalRequest should be created. There can only be one peer per LocalRequest.

On Success

• A new LocalRequest for the given parameters is created in status Draft and returned, but so far not sent to the given peer.

On Failure

• The LocalRequest cannot be created if the peer is the creator itself.
• The LocalRequest cannot be created if the expiration date of the Request contained within its content property is in the past.
• The LocalRequest cannot be created if no Relationship to the peer exists.
• The LocalRequest cannot be created if the Request specified as content is malformed.
• The LocalRequest cannot be created if its acceptance would lead to the creation of more than one RelationshipAttribute in the context of the Relationship to the peer with the same key, owner and value.@type.

For more details on the failure to create a LocalRequest, execute the Check if outgoing Request can be created use case.

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: