Utility.Settlement.App.V1.Service.User

Templates

template UserService

User service for the Settlement App.

Signatory: operator, user

Field	Type	Description
operator	Party	The utility operator.
user	Party	The user.

• Choice Archive

  Controller: operator, user

  Returns: ()

  (no fields)

• Choice UserService_AcceptDvpProposal

  Accepts a Dvp proposal.

  Controller: user

  Returns: DvpProposal_Accept_Result

  Field	Type	Description
  cid	ContractId DvpProposal	The Dvp proposal.
  payload	DvpProposal_Accept	The accept payload.

• Choice UserService_CancelDvpProposal

  Accepts a Dvp proposal.

  Controller: user

  Returns: DvpProposal_Cancel_Result

  Field	Type	Description
  cid	ContractId DvpProposal	The Dvp proposal.
  payload	DvpProposal_Cancel	The cancel payload.

• Choice UserService_ProposeDvp

  Propose to enter into a Dvp.

  Controller: user

  Returns: UserService_ProposeDvp_Result

  Field	Type	Description
  proposerIsBuyer	Bool	Whether the user is the buyer.
  counterparty	Party	The counterparty of the Dvp.
  terms	Terms	Terms for Dvp.

• Choice UserService_RejectDvpProposal

  Accepts a Dvp proposal.

  Controller: user

  Returns: DvpProposal_Reject_Result

  Field	Type	Description
  cid	ContractId DvpProposal	The Dvp proposal.
  payload	DvpProposal_Reject	The reject payload.

• Choice UserService_Terminate

  Terminates the user service.

  Controller: actor

  Returns: UserService_Terminate_Result

  Field	Type	Description
  actor	Party	Party initiating the termination of the UserService contract.

template UserServiceRequest

A user service request.

Signatory: user

Field	Type	Description
operator	Party	Service operator.
user	Party	User.

• Choice Archive

  Controller: user

  Returns: ()

  (no fields)

• Choice UserServiceRequest_Accept

  Accept UserService request.

  Controller: operator

  Returns: UserServiceRequest_Accept_Result

  Field	Type	Description
  operatorConfigurationCid	ContractId OperatorConfiguration	Operator configuration.
  credentialCids	[ContractId Credential]	User’s onboarding credentials.

• Choice UserServiceRequest_Cancel

  Cancel UserService request.

  Controller: user

  Returns: UserServiceRequest_Cancel_Result

  (no fields)

• Choice UserServiceRequest_Reject

  Reject UserService request.

  Controller: operator

  Returns: UserServiceRequest_Reject_Result

  Field	Type	Description
  reason	Text	Rejection reason.

Data Types

data UserServiceRequest_Accept_Result

Result of UserServiceRequest_Accept.

UserServiceRequest_Accept_Result

Field	Type	Description
userServiceCid	ContractId UserService	User Service.

data UserServiceRequest_Cancel_Result

Result of UserServiceRequest_Cancel.

UserServiceRequest_Cancel_Result

(no fields)

data UserServiceRequest_Reject_Result

Result of UserServiceRequest_Reject.

UserServiceRequest_Reject_Result

Field	Type	Description
reason	Text	Rejection reason.

data UserService_CancelDvpProposal_Result

Result of UserService_CancelDvpProposal.

UserService_CancelDvpProposal_Result

(no fields)

data UserService_CreateDvpProposal_Result

Result of UserService_RejectDvpProposal.

UserService_CreateDvpProposal_Result

(no fields)

data UserService_ProposeDvp_Result

Result of UserService_ProposeDvp.

UserService_ProposeDvp_Result

Field	Type	Description
dvpProposalCid	ContractId DvpProposal	The created DVP proposal.

data UserService_Terminate_Result

Result of UserService_Terminate.

UserService_Terminate_Result

(no fields)